Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document API endpoints and returned JSON schema #175

Open
gridhead opened this issue Sep 29, 2021 · 10 comments
Open

Document API endpoints and returned JSON schema #175

gridhead opened this issue Sep 29, 2021 · 10 comments
Labels
D: contributor experience Quality-of-life improvements or changes to project contribution processes or resources documentation Improvements or additions to documentation fragment A functional rewrite of the project good first issue Good for newcomers hacktoberfest Contribute here to get a free tee

Comments

@gridhead
Copy link
Member

Document API endpoints and returned JSON schema

@gridhead gridhead added good first issue Good for newcomers documentation Improvements or additions to documentation D: contributor experience Quality-of-life improvements or changes to project contribution processes or resources fragment A functional rewrite of the project labels Sep 29, 2021
@gridhead gridhead added the hacktoberfest Contribute here to get a free tee label Sep 30, 2021
@Kadermiyanyedi
Copy link

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

@gridhead
Copy link
Member Author

gridhead commented Oct 1, 2021 via email

@Kadermiyanyedi
Copy link

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
Copy link
Member Author

gridhead commented Oct 1, 2021 via email

@Kadermiyanyedi
Copy link

Kadermiyanyedi commented Oct 4, 2021

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

@copperii
Copy link

@shubhamkarande13
Copy link

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

@gridhead
Copy link
Member Author

gridhead commented Mar 8, 2024

@shubhamkarande13 there you go.

@shubhamkarande13
Copy link

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?

@shubhamkarande13 shubhamkarande13 removed their assignment Mar 12, 2024
@gridhead
Copy link
Member Author

@shubhamkarande13 please go ahead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
D: contributor experience Quality-of-life improvements or changes to project contribution processes or resources documentation Improvements or additions to documentation fragment A functional rewrite of the project good first issue Good for newcomers hacktoberfest Contribute here to get a free tee
Projects
None yet
Development

No branches or pull requests

4 participants