Add documentation to the API endpoint

iati-data-access / data-backend

GNU Affero General Public License v3.0

1 stars 0 forks source link

Add documentation to the API endpoint #7

Open markbrough opened 1 year ago

markbrough commented 1 year ago

There is currently some documentation for the API endpoint but it would be really useful to have a more fully documented API endpoint. This could use e.g. the OpenAPI specification and have a simple user interface to allow users to experiment with different queries.

simon-20 commented 1 year ago

From @markbrough: this could potentially be done with:

For the OpenAPI schema: https://flask-smorest.readthedocs.io/
For the front end: https://github.com/Rebilly/ReDoc or https://swagger.io/tools/swagger-ui/