Definir acuerdo de interfaz - Githubissues

Open-Bootcamp / productos-km0

15 stars 3 forks source link

Definir acuerdo de interfaz #36

Open pedrovelasquez9 opened 2 years ago

pedrovelasquez9 commented 2 years ago

Documentar acuerdo de interfaz con endpoints, ejemplos de retorno, parámetros y posibles status code que tendrá la API de backend

El acuerdo de interfaz puede hacerse con Swagger o en un markdown.

[x] Definir endpoints en base a entidades y funcionalidades de la app
[x] Definir headers de autenticación
[x] Definir posibles parámetros y filtrado de los endpoints que apliquen
[ ] Definir body de los responses de cada endpoint
[ ] Documentar y ejemplificar todo lo anterior en un acuerdo de interfaz
[ ] Compartir acuerdo con el equipo de frontend

fabricioAburto commented 2 years ago

https://gelatinous-geometry-f62.notion.site/Productos-KM0-API-Documentation-67c4dbfee7fa42e9a4d946fb64f78ef8