OpenAPI-Dateien bündeln und validieren – eine veröffentlichungs…

OpenAPI-Dateien bündeln und validieren – eine veröffentlichungsreife Spezifikation mit swagger-cli erstellen

Löst mehrteilige OpenAPI-Definitionen in ein einziges, validiertes Artefakt auf – noch bevor Dokumentation, Codegenerierung oder CI-Gates auf die Spezifikation angewiesen sind.

Voraussetzungen

Node.js, npm oder npx sowie eine oder mehrere Swagger/OpenAPI-JSON- oder YAML-Dateien mit lokalen oder entfernten $ref-Zielen nach Bedarf

Installation

Verwenden Sie den offiziellen Installations- oder Einrichtungspfad, der Ihrer Umgebung entspricht:

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

Anforderungen und Hinweise aus dem Originalprojekt:

• Es gibt ein nützliches Python-Tool namens pre-commit, mit dem eine breite Palette von Pre-Commit-Prüfungen ausgeführt werden kann. Der Befehl swagger-cli validate kann als Teil eines Git-Pre-Commit-Hooks integriert werden...

Grundlegende Nutzung oder Einstiegsnotizen:

---

• bash

• swagger-cli [options]

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

• Aus der offiziellen Dokumentation extrahiert: https://raw.githubusercontent.com/APIDevTools/swagger-cli/HEAD/README.md

Dokumentation

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

Quelle

• Agent Skill Exchange