Open Api SWAGGER
Herramienta dedicada a la documentación de APIs RESTful y un sandbox
¿Que es Open API?
Es una especificación para archivos de interfaz legibles por máquina para describir, producir, consumir y visualizar servicios web RESTful. Comenzó como parte del marco Swagger, y se convirtió en un proyecto separado en 2016, supervisado por la Iniciativa OpenAPI, un proyecto de colaboración de código abierto de la Fundación Linux. Swagger y algunas otras herramientas pueden generar código, documentación y casos de prueba con un archivo de interfaz.
¿Que es Swagger?
Swagger es un framework para documentar APIs Rest desde muy diferentes fuentes:
Archivos de configuración, XML, C#, Javascript, Ruby, PHP, Java, Scala… además existen multitud de módulos que te pueden ayudar a integrarlo en tu proyecto.
Con swagger puedes describir, producir, consumir y visualizar APIs, por lo que te será interesante como desarrollador de tu proyecto, pero también desde el punto de vista de un tercero que pudiese consumir tu API, o un usuario que busca información sobre un error o como tu API esta construida, o un tester de tu equipo que quiere probar la funcionalidad de backend como primera medida para excluir un fallo en esta lado para centrarse en Frontend o no.
Autor: http://ramonabadypuntonet.org/2017/04/04/que-es-swagger/
Documentación Manual
En la documentación oficial viene como estructurarlo junto con todos los campos que debería, algo muy importante es la indentación.
Segmento openapi y la información
Segmento de los servidores
Segmento de las rutas
Segmento de las respuestas
Lo único imposible es aquello que no se intenta!
