Open ael-code opened 9 years ago
The only solutions that seem right to me are the sphinx-based ones, that is sphinxcontrib.httpdomain
and sphinx-swagger
. However, I'm not totally sure that sphinx-swagger does what I think it does or what you say it does. I say so because its directive
.. swaggerurl:: URL
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:
/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?