Unificar y validar archivos OpenAPI en una especificación publicable con swagger-cli
Resuelve definiciones OpenAPI de múltiples archivos en un único artefacto validado antes de que la documentación, generación de código o puertas CI dependan de la especificación.
Prerrequisitos
Node.js, npm o npx, y uno o más archivos Swagger/OpenAPI JSON o YAML con referencias locales o remotas $ref según sea necesario.
Instalación
Usa la instalación oficial o la configuración de entorno que se adapte a tu flujo de trabajo:
- npm install -g @apidevtools/swagger-cli
- git clone https://github.com/APIDevTools/swagger-cli.git
- npm install
- npm test
Requisitos y notas importantes de la fuente original:
- Existe una útil herramienta Python llamada pre-commit que se puede utilizar para ejecutar una amplia batería de comprobaciones previas al commit. El comando de validación de swagger-cli se puede integrar como parte de un pre-commit de git...
Notas de uso básico o inicio rápido:
-
bash
-
swagger-cli [opciones]
-
Extraído de la documentación oficial: https://raw.githubusercontent.com/APIDevTools/swagger-cli/HEAD/README.md