search

openfoodfacts / search-a-licious

🍊🔎 A pluggable search service for large collections of objects (like Open Food Facts)
https://search.openfoodfacts.org
GNU Affero General Public License v3.0
6 stars 4 forks source link

Write API documentation #21

Closed alexgarel closed 9 months ago

alexgarel commented 1 year ago

We should document the API.

Writing an OpenAPI documentation should be the choice.

We also generally follow https://diataxis.fr/ schema. So OpenAPI doc should go in docs/reference.

raphael0202 commented 1 year ago

API can be generated very easily with fastapi: https://fastapi.tiangolo.com/tutorial/first-steps/?h=openapi#interactive-api-docs

raphael0202 commented 9 months ago

Done, all endpoints are documented now using FastAPI.