¿Qué es Swagger y para qué sirve este conjunto de herramientas de código abierto?
El mundo de la programación crece cada día más y ha dejado de estar confinado a lenguajes y navegadores. En el proceso de crear un proyecto de programación, utilizamos muchas más herramientas que nos permiten testar nuestros códigos y trabajar colaborativamente. En este post, te contaremos qué es Swagger y para qué sirve, ya que se trata de una de las herramientas más importantes en el desarrollo de API.
¿Qué es Swagger?
Antes de explicarte qué es Swagger y cómo funciona, te sugerimos refrescar tu conocimiento sobre las API, también conocidas como Application Programming Interface. Para ello, te recomendamos ver un vídeo muy simple que nos explica este concepto: What is an API? de Mulesoft.
Entonces, ¿qué es Swagger? Swagger es una documentación online que se genera sobre una API. Por lo tanto, en esta herramienta podemos ver todos los endpoint que hemos desarrollado en nuestra API Swagger. Además, nos demuestra cómo son los elementos o datos que debemos pasar para hacer que funcione y nos permite probarlos directamente en su interfaz.
Para probar los elementos de tu API en Swagger, puedes hacer clic sobre tu endpoint, donde encontrarás un botón que lee “try it out”. Entonces, si tu API Swagger tiene, por ejemplo, un endpoint de signup, Swagger te permitirá probar la creación de usuario y editar el código. Después de esto, podrás hacer clic sobre el botón azul “Execute” para ejecutar el código editado. Al hacer esto, obtendrás una instrucción para ejecutar el curl y la respuesta a la acción ejecutada.
Desde KeepCoding, te recomendamos que, cada vez que estés trabajando con Swagger, te acostumbres a abrir la ventana de inspección de tu navegador. Allí, puedes dirigirte a la sección Network y marcar Fetch/XHR para ver cómo hace las peticiones este frontal. ¿Por qué te recomendamos esto? Pues porque las peticiones, tal cual como las haga Swagger, será como las deberás hacer en tu código. Entonces, con Fetch/XHR podrás ver cómo está montada la petición, cómo son las cabeceras o cómo viene la respuesta, entre otros aspectos.
Cada vez que hagas una petición con Swagger, aparecerá esta petición en Fetch/XHR bajo la categoría ‘Name’. Allí, podrás hacer clic en cualquiera de las peticiones que has hecho para acceder a su cabecera, revisar qué payload llevan (qué datos se han pasado y en qué formato), ver su previsualización y conseguir su respuesta. Esto te ayudará a entender cómo debes crear dicha petición en tu código.
¿Qué pasa si los endpoint de Swagger están bloqueados? Puede que cuando entres a Swagger veas un símbolo de candado en algunos de tus endpoint. Esto significa que este endpoint está protegido y debes pasarle un token para acceder a sus respuestas. La forma en la que accederás al token varía según tu proyecto. Por ello, te recomendamos hablar con tu equipo para conocer la forma de acceder a estos endpoint protegidos. Normalmente, el acceso se dará ejecutando una serie de acciones con las que obtendrás un token como respuesta.
Si te emociona la idea de tener una documentación online de tu API Swagger para poder testar en equipo, te recomendamos ir a la página oficial de Swagger, explorar sus herramientas y empezar a usarla.
Ahora que sabes qué es Swagger y cómo funciona esta herramienta fundamental para el desarrollo web, te invitamos a seguir aprendiendo sobre este mundo en nuestra formación intensiva: el Desarrollo Web Full Stack Bootcamp. En este bootcamp aprenderás de forma teórica y práctica todo lo necesario para ser un experto del desarrollo web en pocos meses, desde lenguajes de programación, como JavaScript, CSS y HTML, hasta herramientas y bibliotecas, como React, Babel y Prettier. ¿A qué esperas para empezar? ¡Matricúlate ya y conviértete en un experto!
