felipet / lacoctelera_backend

Backend for La Coctelera web service
https://felipet.github.io/lacoctelera_backend/
Mozilla Public License 2.0
0 stars 0 forks source link

Fully define the REST API routes #12

Closed felipet closed 1 month ago

felipet commented 2 months ago

Provide a diagram or some sort of documentation about the full tree of routes that the API will include. Once reviewed the proposal, the endpoints can be declared in the source code so the Open API docs can be generated. This would generate the best documentation that contains a full picture of the whole REST API.

felipet commented 2 months ago

@vera-zhurba , this is the initial proposal for the REST API v0.2:

/
/echo <- GET, OPTIONS
/health <- GET, OPTIONS
/ingredient <- GET, POST, HEAD, OPTIONS
/author
                /{id} <- DELETE, GET, HEAD, PATCH, OPTIONS
                /auth <- GET, OPTIONS
/tag <- DELETE, GET, HEAD, PATCH, POST, OPTIONS
/recipe <- GET, HEAD, OPTIONS, POST
                                /{id} <- GET, HEAD, OPTIONS, PATCH, DELETE
                /featured <- GET, HEAD, OPTIONS
felipet commented 2 months ago

During the development of this task, I realised that I must define the data objects that are related to the endpoints first, if I really want to define the endpoints doc realistically. Hence, I'll resume this task when I complete the initial definition of all involved DO.

See [GH-14]

felipet commented 1 month ago

The methods for the endpoint /recipe/{id} will be declared later on (but GET, which is already declared). The same applies to the endpoint tag. The v0.2 milestone is running late already, so those features will be included in a later release.