Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OpenApi in Burger Queen API Doc #1156

Merged
merged 6 commits into from
May 9, 2022

Conversation

ssinuco
Copy link
Collaborator

@ssinuco ssinuco commented Mar 7, 2022

En este PR propongo actualiza la documentacion del API de Burger Queen para que use OpenAPI specification.

https://app.swaggerhub.com/apis-docs/ssinuco/BurgerQueenAPI/2.0.0

Al usar esto hay varias mejoras:

  • Es más claro el json de peticion y respuesta de cada endpoint, incluso incluí varios ejemplos
  • Es más claro el metodo de autenticacion de cada endpoint
  • En la documentación anterior, para las peticiones de error (4xx) no era claro que json debian entregarse. Aqui propongo que sea { "error": "Mensaje de error"}
  • El API esta en swaggerhub. Es publico y dan un mock server del API usando los ejemplos de cada endpoint. Tambien se puede probar el API ahi mismo en la documentación.

@mfdebian @lupomontero @merunga, que opinan?

@ssinuco ssinuco changed the title Add OpenApi version of API documentation Use OpenApi in Burger Queen API Doc Mar 7, 2022
@ssinuco ssinuco changed the title Use OpenApi in Burger Queen API Doc OpenApi in Burger Queen API Doc Mar 7, 2022
@mfdebian mfdebian self-assigned this Mar 22, 2022
@mfdebian mfdebian added enhancement New feature or request idea Ideas, sugerencias, comentarios generales y feedback content Relacionado al contenido de proyectos y tópicos labels Mar 22, 2022
@mfdebian mfdebian added this to the v5.1.0 milestone Mar 22, 2022
@mfdebian mfdebian self-requested a review March 22, 2022 15:58
@mfdebian
Copy link
Collaborator

Hola @ssinuco! 🚀

Está muy interesante, me gustaría pedirte si nos podemos juntar 15 minutitos en algún momento para que me puedas explicar con más detalle los schemas propuestos en la app de swaggerHub y qué papel juega el archivo burger-queen-api.yml para poder entenderlo mejor 😊

@mfdebian mfdebian marked this pull request as ready for review May 3, 2022 15:44
@mfdebian mfdebian merged commit f044847 into Laboratoria:main May 9, 2022
mfdebian added a commit to mfdebian/curriculum that referenced this pull request May 16, 2022
* Add OpenApi version of API documentation

* Add OpenApi yml file

* Compatibility with json-server mock: changing POST /auth for POST /login. Changing all PUT operations for PATCH operations.

* Update projects/04-burger-queen-api/burger-queen-api.yml

Adds newline at EOF.

Co-authored-by: Alfredo González <12631491+mfdebian@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Relacionado al contenido de proyectos y tópicos enhancement New feature or request idea Ideas, sugerencias, comentarios generales y feedback
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants