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.

Sign up for GitHub

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

Jump to bottom

Add API documentation #2

Open

gabrielpreda opened this issue Aug 14, 2018 · 0 comments

Assignees

Labels

Owner

gabrielpreda commented Aug 14, 2018

Add API documentation
Current implementation is using Flask and Python to create a web API

Acceptance criteria:

all functions exposed should have documentation
examples for use of each function should be provided

Note: Flask, Swagger UI and Flask-RESTPlus could be used to create a basic documentation of the existing API; here is an example: http://michal.karzynski.pl/blog/2016/06/19/building-beautiful-restful-apis-using-flask-swagger-ui-flask-restplus/

gabrielpreda added the enhancement label

gabrielpreda self-assigned this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment