Regrouper et valider des fichiers OpenAPI en une spécification…

Regrouper et valider des fichiers OpenAPI en une spécification publiable avec swagger-cli

Résoudre les définitions OpenAPI multi-fichiers en un artefact validé avant que la documentation, la génération de code ou les portes CI ne dépendent de la spécification.

Prérequis

Node.js, npm ou npx, et un ou plusieurs fichiers Swagger/OpenAPI JSON ou YAML avec des cibles de référence locales ou distantes ($ref) si nécessaire.

Installation

Utilisez la méthode d'installation ou de configuration en amont qui correspond à votre environnement :

• npm install -g @apidevtools/swagger-cli
• git clone https://github.com/APIDevTools/swagger-cli.git
• npm install
• npm test

Exigences et remarques en amont :

• Il existe un outil Python utile appelé pre-commit qui peut être utilisé pour exécuter une large suite de vérifications de pré-commit. La commande swagger-cli validate peut être intégrée dans le cadre d'un pré-commit Git...

Notes d'utilisation de base ou de mise en route :

---

• bash

• swagger-cli [options]

• Source : https://github.com/APIDevTools/swagger-cli

• Extrait de la documentation en amont : https://raw.githubusercontent.com/APIDevTools/swagger-cli/HEAD/README.md

Documentation

• https://github.com/APIDevTools/swagger-cli

Source

• Agent Skill Exchange