QGasSP / ggia-backend

Greenhouse gas calculation app for ESPON
1 stars 3 forks source link

Generate API endpoint documentation automatically #11

Open ulno opened 2 years ago

ulno commented 2 years ago

Could Swagger (https://swagger.io/) be a solution for this or swagger in flask (https://www.imaginarycloud.com/blog/flask-python/)? Swagger might though be overkill as we already use flask, so maybe there is a more pythonic/flask like solution to automate the api documentation creation? Maybe something like this (https://flask-apispec.readthedocs.io/en/latest/)?

stackeduary commented 2 years ago

@ulno Please see www.imaginarycloud.com/blog/flask-python

We think the juice isn't worth the squeeze. Since we only have a small number of endpoints, writing the documentation by hand is much, much easier and more efficient for this project.

flask routes gives a good overview of our current routes.

Thoughts @mir-jalal?