API Documenter
API-Dokumentation erstellen
Entwickler verbringen Stunden damit, API-Dokumentation manuell zu schreiben. Diese Fähigkeit automatisiert die Erstellung umfassender API-Dokumentation aus Code oder OpenAPI-Spezifikationen und spart Zeit sowie ensures Konsistenz.
Die Skill-ZIP herunterladen
In Claude hochladen
Gehe zu Einstellungen → Fähigkeiten → Skills → Skill hochladen
Einschalten und loslegen
Teste es
Verwendung von "API Documenter". Generate API docs for a GET /users/{id} endpoint that returns user profile data
Erwartetes Ergebnis:
- # GET /users/{id}
- Retrieves a user profile by unique identifier.
- ## Request
- - Method: GET
- - Path: /users/{id}
- - Auth: Bearer token required
- ## Response 200
- ```json
- {"id": "user_123", "name": "John Doe", "email": "john@example.com"}
- ```
Verwendung von "API Documenter". Document this OpenAPI spec for a pets API
Erwartetes Ergebnis:
- # Pet Store API
- ## Overview
- RESTful API for managing pet inventory.
- ## Endpoints
- - GET /pets - List pets
- - POST /pets - Add pet
- -GET /pets/{id} - Get pet
- - DELETE /pets/{id} - Remove pet
Sicherheitsaudit
SicherThis is a prompt-only skill that generates API documentation. Static analysis found no executable code, no network requests, no filesystem access, and no external command execution. The skill contains only natural language prompts for generating documentation content.
Qualitätsbewertung
Was du bauen kannst
Schnelle API-Dokumentation für interne Dienste
Schnelle Dokumentationserstellung für interne Microservices während Entwicklungssprints
Öffentliche API-Dokumentation
Erstellen von polierter, benutzerorientierter Dokumentation für öffentliche API-Produkte
Wiederherstellung von Legacy-API-Dokumentation
Dokumentation für undokumentierte Legacy-APIs durch Code-Analyse erstellen
Probiere diese Prompts
API-Dokumentation für den folgenden Endpunkt erstellen: [Endpunktcode oder Beschreibung einfügen]
Umfassende API-Dokumentation für diese OpenAPI-Spezifikation erstellen: [OpenAPI JSON/YAML einfügen]
API-Dokumentation mit Code-Beispielen in Python, JavaScript und curl erstellen für: [Endpunktdetails einfügen]
Polierte Markdown-API-Dokumentation mit Abschnitten für Übersicht, Endpunkte, Authentifizierung, Fehlercodes und Beispiele erstellen: [API-Spezifikation einfügen]
Bewährte Verfahren
- Vollständige OpenAPI-Spezifikationen für beste Ergebnisse bereitstellen
- Authentifizierungsdetails in der Eingabe angeben
- Generierte Beispiele vor der Veröffentlichung auf Richtigkeit überprüfen
Vermeiden
- Erwarten von Live-Tests von API-Endpunkten
- Unvollständige oder mehrdeutige Endpunktbeschreibungen bereitstellen
- Annehmen, dass die Fähigkeit Ihre spezifischen internen Konventionen kennt