Zum Hauptinhalt springen

Open-Source-Bibliotheken

Powerduck besteht aus kleinen, kombinierbaren npm-Paketen. Desktop-Client und Clouddienst bauen auf denselben Bibliotheken auf. So laufen dieselben Komponenten lokal, über das Netzwerk oder in Ihren eigenen Werkzeugen.

Jedes Paket wird unabhängig veröffentlicht und hat eigene Installationshinweise, eine API-Referenz und Beispiele. Diese Seite beschreibt Aufgaben und Zusammenspiel der Pakete.

Aufbau der Schichten​

Powerduck / Cloud
↓
Einbettbare Oberfläche
↓
Abläufe
↓
Grundlage

Parser und Konverter bilden die Grundlage. Darauf bauen übergeordnete Abläufe und schließlich die einbettbare Oberfläche auf. Die gemeinsame Basis sorgt für einheitliches Verhalten, ohne das Parsing in jedem Paket erneut zu implementieren.

Die Pakete​

Grundlage​

PaketAufgabe
@powerduck/openapi-parserOpenAPI-/Swagger-Dokumente parsen, validieren und aktualisieren
@powerduck/conf-patchStrukturierte, validierte Konfigurationsänderungen anwenden
@powerduck/x-to-openapiAndere Formate wie cURL und Postman in OpenAPI umwandeln

Abläufe​

PaketAufgabe
@powerduck/openapi-cliMehrprotokoll-Abläufe über die Kommandozeile, einschließlich Szenarioläufen
@powerduck/openapi-codegenClientcode und weitere Artefakte aus einer Spezifikation erzeugen
@powerduck/openapi-mcp-serverEine OpenAPI-Spezifikation als MCP-Server bereitstellen
@powerduck/openapi-requestIn einer Spezifikation beschriebene Anfragen ausführen

Einbettbare Oberfläche​

PaketAufgabe
@powerduck/oas-documentOpenAPI als lesbare Dokumentation darstellen, mit React-Einstiegspunkt
@powerduck/md-editorEinbettbarer Markdown-Editor
@powerduck/schema-editorEinbettbarer JSON-Schema-Editor
@powerduck/treeBaumkomponente für strukturierte Daten
@powerduck/workspace-yamlIntegration von Workspace-YAML

Das passende Paket auswählen​

  • OpenAPI-Dateien lesen, validieren oder aktualisieren: Beginnen Sie mit openapi-parser.
  • cURL oder eine Postman-Sammlung in OpenAPI umwandeln: Verwenden Sie x-to-openapi.
  • Szenarien oder Mehrprotokoll-Abläufe über Kommandozeile oder CI ausführen: Verwenden Sie openapi-cli.
  • Clientcode erzeugen: Verwenden Sie openapi-codegen.
  • Eine API als Tools für einen KI-Agenten bereitstellen: Verwenden Sie openapi-mcp-server.
  • Gerenderte Dokumentation in eine React-App einbetten: Verwenden Sie oas-document mit React-Einstiegspunkt und zugehörigem CSS.
  • Einen Editor einbetten: Verwenden Sie md-editor oder schema-editor.

Funktionen mit Agenten teilen​

Über das MCP-Server-Paket können auch externe KI-Agenten die Funktionen nutzen. Eine mit openapi-mcp-server bereitgestellte Spezifikation stellt ihre Operationen als MCP-Tools zur Verfügung. Derselbe Vertrag, der Dokumentation und Codegenerierung bestimmt, lässt sich damit direkt vom Agenten aufrufen. Desktop-Client, Cloud und weitere MCP-kompatible Werkzeuge arbeiten so mit derselben maßgeblichen Definition.

Hinweise zu den Beispielen​

Die Codebeispiele orientieren sich an der tatsächlichen Paket-API und sollen wie gezeigt ausführbar sein. Prüfen Sie nach einem Paketupdate die Versionshinweise auf aktuelle Parameter, statt Beispiele älterer Versionen ungeprüft zu übernehmen.

Über die Seitenleiste erreichen Sie Installation, Konfiguration und vollständige API-Referenz jedes Pakets.