Skip to content
This repository has been archived by the owner on Aug 17, 2023. It is now read-only.

Problema con Swagger #108

Closed
EleaTriesToCode opened this issue May 31, 2023 · 6 comments
Closed

Problema con Swagger #108

EleaTriesToCode opened this issue May 31, 2023 · 6 comments

Comments

@EleaTriesToCode
Copy link

Holis :D

He intentado añadir Swagger a mi proyecto, siguiendo el ejemplo dado en la pagina del enuciado (https://ljn.io/posts/swagger-for-a-koa-api)... pero no me funciona todavía y no entiendo porque :/

Eso es mi código de app.js :
image

Y eso es el error que me sale :
image

Existen unos posts en stackoverflow con problemas similiares, pero en contextos más complejos y no logro entender bien los consejos dados...

También si me prodrían confirmar que basta crear una "celda Swagger" para cada request/response del API para que la documentación sea completa ? O necesitamos también crear más test a parte ?

Gracias por su ayuda, saludos :)

@gonzaloi21
Copy link

Tenemos el mismo error!

@rlabb
Copy link

rlabb commented May 31, 2023

Por acá también

@valeeeriquelme
Copy link
Contributor

Hola, aún no se muy bien a que se podría deber el error. Sin embargo, para no atrasar su desarrollo, sugiero que intenten documentando en swaggerHub, de esa forma no deben integrar nada dentro de su api.

@valeeeriquelme
Copy link
Contributor

Hola! les dejo este repo para que se guíen con la documentación con swagger. Está actualizada y no debería tener los mismos problemas que el otro link https://github.com/IIC2513/swagger-koa

@valeeeriquelme valeeeriquelme pinned this issue Jun 1, 2023
@EleaTriesToCode
Copy link
Author

Hola ! Gracias por la nueva guia, ahora podemos acceder a Swagger, pero con unos problemas todavia...

Se debe poder conectar Swagger a la base de datos ? Como hacer que los "Try it out" de Swagger hacen lo mismo que en Postman, modifican la DB y entregan el response body real obtenido ? O solo debe ser un catalogo informativo, y no se usaran los "Try it out" ?

De momento, mi Swagger hace algo extraño en sus Try it out, envia la request pero de tal manera que el resultado obtenido para el mismo body es distinto que en Postman. O sea usando Postman todo funciona perfectamente, pero al hacer un Try it out en Swagger que supuestamente genera los mismos get/post, no funciona bien.

Eso es por ejemplo lo que tengo en mi openapi.yml, con un get simple que debe darnos la lista de usuarios en la DB :

image

Y el swagger :
image

En la consola se lee al hacer un try it out de este get en Swagger :
image

Pero en Swagger no aparece nada :/

Que estamos haciendo mal ? Se debe usar los Try it out de Swagger ? O mejor tenerlo solamente como un catalogo fijo informativo, y hacer solo los tests en Postman ? En este caso, la documentacion debe incluir una guia de tests a hacer en orden para ver todas las funcionalidades ?
Lo mas facil para mi seria crear un readMe bien completo con unas propuestas de tests en orden, y quizas tener el swagger tambien pero solo como catalogo fijo. Se puede hacer eso ?

Lo siento son muchas preguntas, pero no entiendo como funciona Swagger y hasta que punto debemos usarlo en esta entrega....

@valeeeriquelme
Copy link
Contributor

No aparece ningún error en la consola del navegador que de indicios de por qué no se muestra?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants