SWAGGER

SWAGGER

¿Qué es?

Es una reciente tecnología para documentar de manera automatizada las funciones de una API sin importar el lenguaje que utilicen para dicha API, dependiendo de cómo es implementada puede crear una documentación que sea accesible para cualquier programador, desarrollador, o persona que tenga nociones básicas sobre lenguajes de programación.

Lo bueno de Swagger es que:

 “Swagger es una serie de reglas, especificaciones y herramientas que nos ayudan a documentar nuestras APIs.”

Lo cual permite intercambiar documentación con otros programadores y ayuda a entender gran parte del código empleado para modificar, mejorar o borrar código que sea innecesario a través de plataformas como GITHUB.

Esta tecnología utiliza herramientas como:

SWAGGER UI

Es la interfaz html mediante la cual se Ordenan todos las configuraciones de la API con sus respectivos códigos, mostrando todos los métodos el código que emplean y pruebas para ver los parámetros que generan dichos métodos a través de la introducción de datos.

Como Acceder a dicha herramienta:

A través de la dirección en línea:

Editor.Swagger.io

[pic 1]

Esta es la muestra, ejemplo que tiene swagger por defecto.

Técnicamente si Swagger esta implementado y conjunto a unas configuraciones que aún deben determinarse en el api local de la aplicación de UTEPSA se podría utilizar esta herramienta para ver como nuestros antiguos compañeros implementaron su código, métodos, estrategias, etc. Y entender mejor como se desarrolló la API.

Swagger también utiliza otras herramientas que aún no he podido verificar. Me falto tiempo

¿Problemas para generar documentación con SWAGGER?

1.- El Swagger debe ser implementado en algún tipo de Consola la cual no está especificada si es en la base de datos o en una especie de consola que maneja node.js aún falta determinar e investigar en cual.

¿Cómo implementarlo?

El Codigo para implementar SWAGGER MODULE en NODE.JS a través de NPM ”investigar que es NPM” es el siguiente:

$ npm install -g swagger

No he podido verificar esto se debería hacer en el centro.

...