Agrupar e validar arquivos OpenAPI em uma especificação publicável com swagger-cli
Resolver definições OpenAPI de múltiplos arquivos em um artefato validado antes que documentação, geração de código ou gates de CI dependam da especificação.
Pré-requisitos
Node.js, npm ou npx, e um ou mais arquivos Swagger/OpenAPI nos formatos JSON ou YAML com referências $ref locais ou remotas conforme necessário
Instalação
Use o método de instalação ou configuração upstream que corresponde ao seu ambiente:
- npm install -g @apidevtools/swagger-cli
- git clone https://github.com/APIDevTools/swagger-cli.git
- npm install
- npm test
Requisitos e observações do upstream:
- Existe uma ferramenta Python útil chamada pre-commit que pode ser usada para executar uma ampla gama de verificações de pré-commit. O comando swagger-cli validate pode ser integrado como parte de um git pre-commit...
Notas de uso básico ou primeiros passos:
-
bash
-
swagger-cli [options]
-
Extraído da documentação upstream: https://raw.githubusercontent.com/APIDevTools/swagger-cli/HEAD/README.md