alexandria-reader / backend

Alexandria reading app back end
https://tryalexandria.com/
6 stars 1 forks source link

API Documentation #154

Open medic-code opened 1 year ago

medic-code commented 1 year ago

I read somewhere in the PRs you were using Postman to test the API. Has API documentation been created ? Wondered if this is something you'd considered for contribution purposes, perhaps on a ask per request nature.

Postman seems like an obvious choice, particularly if you've already designed the API in postman using the OpenAPI 3.0 spec.

https://learning.postman.com/docs/publishing-your-api/documenting-your-api/#generating-api-documentation

eamon0989 commented 1 year ago

Unfortunately we do not currently have any API docs, we tried to design the endpoints to be easily readable, but of course, something like OpenAPI or Swagger would be a fantastic enhancement.