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

Rest api docs #168

Open
ael-code opened this issue Jun 17, 2015 · 1 comment · May be fixed by #306
Open

Rest api docs #168

ael-code opened this issue Jun 17, 2015 · 1 comment · May be fixed by #306

Comments

@ael-code
Copy link
Member

How do we want to provide docs for REST API?

I'll try to list some different options:

  • we could use sphinxcontrib and the flask plugin to provide documentation through sphinx and rtfd.org
  • @hellais in Rest Api #52 suggests to use Swagger for documenting API. I already use it and I like this tools.
    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?

@ael-code ael-code added this to the 0.3 milestone Jun 28, 2015
@ael-code ael-code removed this from the 0.3 milestone Nov 4, 2015
@boyska boyska added the addbook label Dec 3, 2015
@boyska
Copy link
Member

boyska commented Aug 1, 2016

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".

boyska added a commit to boyska/libreant that referenced this issue Aug 1, 2016
boyska added a commit to boyska/libreant that referenced this issue Aug 1, 2016
@boyska boyska linked a pull request Aug 1, 2016 that will close this issue
boyska added a commit to boyska/libreant that referenced this issue Aug 2, 2016
boyska added a commit to boyska/libreant that referenced this issue Aug 2, 2016
@boyska boyska removed the addbook label Aug 2, 2016
boyska added a commit to boyska/libreant that referenced this issue Aug 22, 2016
boyska added a commit to boyska/libreant that referenced this issue Aug 22, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants