-
Notifications
You must be signed in to change notification settings - Fork 8
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
Rest api docs #168
Comments
The only solutions that seem right to me are the sphinx-based ones, that is
seems very strange; why should it get an URL just to document my endpoints? I'd like something to just generate documentation to be put inside the sphinx doc, without requiring a special "service". |
How do we want to provide docs for REST API?
I'll try to list some different options:
We could expose Swagger-UI through flask under something like
/api/docs
but in this case the only way to read the API docs is to run libreant. To resolve this problem we could try some way:What option do you like the most?
Do you know other tools/ways to documenting the REST API?
The text was updated successfully, but these errors were encountered: