IIC2513 / Syllabus-2023-1

Repositorio oficial del curso IIC2513 Tecnologías y Aplicaciones Web 🎉👩‍💻👨‍💻
67 stars 8 forks source link

Problema con Swagger #108

Closed EleaTriesToCode closed 1 year ago

EleaTriesToCode commented 1 year ago

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 commented 1 year ago

Tenemos el mismo error!

rlabb commented 1 year ago

Por acá también

valeeeriquelme commented 1 year ago

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 commented 1 year ago

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

EleaTriesToCode commented 1 year ago

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 commented 1 year ago

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