Se puede usar para gestionar documentos diseñados en desarrollo de APIs. Genera código de ejemplo en JSON y funciona de manera similar a Postman.
Cada vez se usa más en los proyectos actuales.
Iniciar servidor localmente (el ejemplo tiene 3 instancias, para casos con 3 servidores API externos, etc.)
docker pull swaggerapi/swagger-editor
docker run -d -p 8090:8080 swaggerapi/swagger-editor
docker run -d -p 8091:8080 swaggerapi/swagger-editor
docker run -d -p 8092:8080 swaggerapi/swagger-editorAbre http://localhost:8090 en el navegador.
Copia y pega el contenido del archivo yaml del repositorio en la ventana izquierda del navegador junto con el control de código fuente.
Realiza pruebas con get, post, etc.
※ Como es una API, necesitas entender la especificación en cierta medida.
La herramienta que se usa frecuentemente junto con esto es OpenAPI
Esta es una herramienta que carga un archivo yaml (archivo de diseño de API) y genera automáticamente el código fuente de las partes I/O en el idioma especificado. Sin embargo, no todo es positivo; a menudo genera código incorrecto también, así que te encontrarás en situaciones donde necesitas hacer limpieza de código problemático.