Vereinfachen Sie Ihre OpenAPI-Dateien mit OpenAPI Trimmer

Die Verwaltung großer OpenAPI-Dateien kann mühsam sein, insbesondere wenn Sie nur einen kleinen Teil der API für bestimmte Aufgaben benötigen. Hier kommt OpenAPI Trimmer zum Einsatz. Es handelt sich um ein leichtes Tool, mit dem Sie Ihre OpenAPI-Dateien so reduzieren können, dass sie nur die Endpunkte und Datenübertragungsobjekte (DTOs) enthalten, die Sie interessieren.

Wie funktioniert es?

Angenommen, Sie arbeiten mit einer großen OpenAPI-Datei, benötigen aber nur die Endpunkte, die sich auf die Quotes-API beziehen. Mit einem einzigen Befehl können Sie ganz einfach nur diese Endpunkte extrahieren und irrelevante DTOs entfernen:

openapi-trimmer -i openapi.yaml \
  -p /v1/quotes,/v1/users \
  -ec CompanyConfigDto,UpdateCompanyConfigDto

Dieser Befehl wird:

• -i openapi.yaml: Verwenden Sie Ihre vorhandene OpenAPI YAML-Datei als Eingabe.
• -p /v1/quotes,/v1/users: Behalten Sie nur die Endpunkte bei, die mit /v1/quotes und /v1/users beginnen.
• -ec CompanyConfigDto,UpdateCompanyConfigDto: Bestimmte Komponenten ausschließen, in diesem Fall CompanyConfigDto und UpdateCompanyConfigDto.

Die gekürzte API-Definition wird als openapi-trimmer.yaml gespeichert.

Validierung

Um die Integrität Ihrer gekürzten OpenAPI-Datei sicherzustellen, validieren Sie sie mit:

swagger-cli validate ./openapi-trimmer.yaml

Mit diesem Schritt können Sie etwaige Probleme erkennen, bevor Sie die gekürzte API-Datei bereitstellen oder freigeben.

Installation

Sie können OpenAPI Trimmer direkt von PyPi installieren:

pip install openapi-trimmer

Weitere Details und die neuesten Updates finden Sie auf der OpenAPI Trimmer PyPi-Seite.

GitHub-Repository: OpenAPI Trimmer auf GitHub.

Befehlszeilenoptionen

Der OpenAPI Trimmer bietet mehrere Optionen zum Anpassen seiner Funktionsweise:

• -h, --help: Hilfeinformationen anzeigen.
• -v, --version: Zeigt die Versionsnummer an.
• -i INPUT, --input INPUT: Geben Sie die Eingabe-YAML-Datei an (erforderlich).
• -o OUTPUT, --output OUTPUT: Definieren Sie den Namen der Ausgabedatei (optional; standardmäßig wird „-trimmed“ an die Eingabedatei angehängt).
• -p PREFIXES, --prefixes PREFIXES: Listen Sie die Pfade auf, die in der Ausgabe beibehalten werden sollen (durch Kommas getrennt).
• -ec EXCLUDE_COMPONENTS, --exclude-components EXCLUDE_COMPONENTS: Listen Sie die auszuschließenden Komponenten auf (durch Kommas getrennt).

Abschluss

OpenAPI Trimmer ist ein unverzichtbares Tool für Entwickler, die ihre OpenAPI-Dateien optimieren möchten, um sie besser verwaltbar und auf spezifische Anforderungen zugeschnitten zu machen. Unabhängig davon, ob Sie eine API-Dokumentation vorbereiten oder eine API für den internen Gebrauch vereinfachen, spart Ihnen OpenAPI Trimmer Zeit und Mühe, indem Sie sich nur auf das konzentrieren, was für Sie am wichtigsten ist.