Document API endpoints and returned JSON schema

[gridhead]

Document API endpoints and returned JSON schema

[Kadermiyanyedi]

Maybe https://github.com/Redocly/redoc or swagger (https://swagger.io/) can be used ?

[gridhead]

Is it compatible with Flask?

On Fri, Oct 1, 2021 at 4:23 PM Kader M. @.***> wrote:

Maybe https://github.com/Redocly/redoc or swagger (https://swagger.io/) can be used ?

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/fedora-infra/mote/issues/175#issuecomment-932125659, or unsubscribe https://github.com/notifications/unsubscribe-auth/AL2O2QUZ6UGGM27ATLEKJ73UEWHLPANCNFSM5E6YU4FQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

[Kadermiyanyedi]

Swagger yes. I saw this package for that.

https://flask-restplus.readthedocs.io/en/stable/swagger.html

or I usually also see this for python documentation:

https://www.sphinx-doc.org/en/master/

[gridhead]

We are not using Flask RESTplus here.

Will it work with barebones Flask?

On Fri, Oct 1, 2021 at 4:37 PM Kader M. @.***> wrote:

Swagger yes. I saw this package for that.

https://flask-restplus.readthedocs.io/en/stable/swagger.html

or I usually also see this for python documentation:

https://www.sphinx-doc.org/en/master/

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/fedora-infra/mote/issues/175#issuecomment-932134704, or unsubscribe https://github.com/notifications/unsubscribe-auth/AL2O2QXIVXOEILOE3UTLMI3UEWI6ZANCNFSM5E6YU4FQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

[Kadermiyanyedi]

I think we will need to download 3rd package(from pypi). We can ignore this suggestion as it complicates things.

[copperii]

https://www.imaginarycloud.com/blog/flask-python/

[shubhamkarande13]

Hi @gridhead! I am Shubham, an Outreachy applicant. Can I work on this issue? I hope it is still relevant.

[gridhead]

@shubhamkarande13 there you go.

[shubhamkarande13]

Hi @gridhead! I would use Swagger and flask-swagger-ui to document the API endpoints and the returned JSON schema. Does that sound good to you?

[gridhead]

@shubhamkarande13 please go ahead.