SECTIONHUB← Sie sind hier

Claude Skills

API Doc

Hält OpenAPI, README und Code-Beispiele mit einer Stimme synchron.

AnthropicGeprüft 01. Nov. 2025

Preis
Gratis
Reife
stable
Lizenz
MIT
Plattformen
macos, linux, windows
Bewertung
4 / 5
Macht API-Doku weniger zur Pflicht und mehr zur Sicht; besonders wertvoll fuer Frameworks, in denen Spec und Code auseinanderlaufen.

Offizielle Seite ↗Repository ↗

Inhalt

Über

api-doc ist ein Anthropic-Skill, der die Lücke zwischen API-Spec und gelebter Doku schließt. Er liest OpenAPI 3.1, JSON-Schema oder tRPC-Definitionen und erzeugt daraus Markdown, Beispiele in curl, Python und TypeScript, und prüft gleichzeitig, ob das Coding die Spec noch einhält. Sobald ein Endpunkt umbenannt oder entfernt wird, meldet der Skill einen Drift-Report.

Praxisbeispiel

Dein Team führt einen neuen Endpoint /v2/orders/:id/cancel ein. Der Skill sieht die OpenAPI-Änderung, erzeugt sofort eine Tabelle mit Pflichtfeldern, ergänzt ein curl-Beispiel mit Bearer-Token und ein fetch-Snippet mit Error-Handling. Eine halbe Stunde später fügt jemand das Response-Schema für 422 nicht hinzu; im Drift-Report taucht die Warnung auf und der Skill verhindert, dass der PR gemergt wird.

Stärken

  • Hält Doc-Generator und Spec synchron; niemand editiert mehr drei README-Dateien parallel.
  • Status-Code-Doku mit echten Snippets, nicht nur mit Text.

Schwächen

  • Bei subschema-reichen GraphQL-APIs stösst der Skill an seine Tabellen-Grenzen und braucht einen ergänzenden Generator.

Bewertung im Detail

Stärken

  • Liest OpenAPI 3.1, JSON-Schema und tRPC-Definitionen einheitlich
  • Generiert curl, fetch, und Python-Beispiele parallel
  • Erkennt Schema-Drift zwischen Spec und Code automatisch
  • Verlinkt Antwort-Beispiele mit konkreten Status-Codes: 200, 404, 422

Schwächen

  • GraphQL Subscriptions werden nicht nativ dokumentiert
  • Lange Specs ueber 5 MB fuehlen sich im Skill träge an
  • Aenderungen am Markdown werden im Output hart umgebrochen

Eckdaten

Lizenz
MIT (open-source)
Vendor
Anthropic
Reifegrad
stable
Erstveröffentlichung
Zuletzt geprüft
Plattformen
macos, linux, windows
Integrationen
Claude CodeOpenAPIFastAPIExpressHono
Use Cases
DokumentationAPI-DesignOnboarding