SWAGGER

¿PARA QUE SIRVE?

Es un framework que nos permite
describir,consumir,visualizar y producir Apis RESTful,
esto quiere decir que esta herramienta sirve
principalmente para traer la documentación y el código
del servidor al mismo tiempo que los desarrolladores la
implementas lo que quiere decir que puede conectarse
al repositorio Github y traer y llevar los datos, por lo
tanto es una herramienta de integración continua

2
¿Qué es una Api?
Una Api es una interfaz de código que permite que
una aplicación se comunique con otra siguiendo
una serie de parámetros, se pueden comunicar con
un sistema operativo, una base de datos esto
permite que gracias a las apis podamos hacer uso
de funciones que ya existen en otro software y no
tengamos que reinventar todo el codigo

3
 ¿Como usar
swagger?
Primero vamos a ir a la pagina
https://swagger.io/ y vamos a dar click en la
opción try swaggerhub, en la siguiente pagina le
vamos a dar la opción sign up free
5
“ Quotations are
commonly printed as a
means of inspiration
and to invoke
philosophical thoughts
from the reader.
6
Como podemos ver nos podemos
registrar manualmente o si
tenemos cuenta de Gith hub
podemos registrarnos con ella

7
8
Con esto obtendremos una pagina así solamente que en
blanco, esta pagina es donde swagger nos manda todos
los proyectos que sean nuestros o que sean mandados
por organización o otras personas

9
10
¿Hay una forma de
instalarlo?
Por supuesto que si pero para este método tenemos que tener
instalado lo que es node.js el cual nos permitirá hacer esta
instalación, si no posee node.js lo puede descargar desde esta
pagina https://nodejs.org/es/download/ y elijes la descarga de
acuerdo a tu sistema operativo cuando se tenga node.js se
ejecutara el siguiente comando en los comandos del sistema

11
12
● Npm install –g swagger instalara swagger en nuestra
terminal lo cual si queremos revisar que versión de
swagger tenemos solo tenemos que dar el siguiente
codigo

13
14
¿como crear un proyecto
en swagger web?
● En nuestra pagina home lo que hacemos es dar en la
pestaña que tiene un signo de mas

15
16
● Hacemos click en crear nueva API
● A continuación se nos mostrara un menú como el
siguiente

17
18
● Nos pedirá que versión de openApi queremos usar
● El modelo del api que queremos usar es mejor cambiar esta
opción a none
● El nombre del proyecto, la versión, el titulo, la descripción, el
propietario, si será publico o privado y por ultimo si queremos
la plantilla pre-definida de swagger
● Una vez tenido todo hecho le damos crear api
● Nuestra ventana quedaría asi

19
20
● Después que hagamos todos esos pasos nos
aparecerá esta pestaña así como va

21
¿Cómo hago para hacer
el proyecto en código
del sistema?
● Es muy fácil primero vamos a ir a código del
sistema y crearemos una carpeta en donde
vamos a poner nuestro proyecto y después
iremos a esa carpeta y crearemos el proyecto
pero ¿como haremos eso? Asi como lo observan a
continuación.

22
23
● Asi crearíamos el proyecto en código del sistema pero nos
falta algo inicializar el proyecto eso se hace con este código
● Swagger Project start diapositivas

24
25