Dieser Workflow unterstützt Entwickler dabei, umfassende API-Dokumentation zu erstellen, indem er sie durch die Erstellung von OpenAPI-Spezifikationen, das Verfassen von Entwickler-Leitfäden, die Generierung von Code-Beispielen und die Einrichtung interaktiver Dokumentation führt.
Télécharger le ZIP du skill
Importer dans Claude
Allez dans Paramètres → Capacités → Skills → Importer un skill
Activez et commencez à utiliser
Tester
Utilisation de "api-documentation". Verwende @api-documentation Workflow, um meine Benutzerverwaltungs-API zu dokumentieren
Résultat attendu:
Ich leite dich durch die Erstellung umfassender API-Dokumentation in 7 Phasen:
**Phase 1: API-Discovery**
- Bestandsaufnahme deiner Endpoints
- Dokumentiere Anfrage/Antwort-Formate
- Identifiziere Authentifizierungsanforderungen
[Leitet durch jede Phase mit konkreten Aktionen]
Utilisation de "api-documentation". Erstelle OpenAPI-Spezifikation für meine E-Commerce-API
Résultat attendu:
Hier ist deine OpenAPI-Spezifikationsstruktur:
```yaml
openapi: 3.0.0
info:
title: E-Commerce API
version: 1.0.0
paths:
/products:
get:
summary: Produkte auflisten
responses:
200:
description: Erfolgreiche Antwort
```
Audit de sécurité
SûrSecurity analysis confirms this is a safe documentation workflow skill. The static analyzer flagged 28 instances of 'external_commands' (Ruby/shell backtick execution) and 9 instances of 'weak cryptographic algorithms', but both are false positives. The backticks in the file are Markdown code spans (e.g., `api-documenter`) used for skill name references, not shell command execution. No actual security risks were identified.
Problèmes à risque moyen (2)
Score de qualité
Ce que vous pouvez construire
Dokumentation für neues API-Projekt
Erstelle vollständige Dokumentation für eine neue REST API von Grund auf, einschließlich OpenAPI-Spezifikation, Entwickler-Leitfaden und interaktiver Dokumentation.
Aktualisierung bestehender API-Dokumentation
Aktualisiere und modernisiere bestehende API-Dokumentation mit OpenAPI-Spezifikationen, Code-Beispielen und interaktiven Try-it-Funktionen.
Erstellung eines internen API-Portals
Baue ein internes API-Portal mit umfassender Dokumentation, Code-Beispielen und Integrationsleitfäden für interne Teams.
Essayez ces prompts
Verwende den @api-documentation Workflow, um Dokumentation für meine REST API zu erstellen. Ich habe eine Endpoint-Liste und benötige Hilfe bei der Generierung von OpenAPI-Spezifikationen und einem Entwickler-Leitfaden.
Verwende @api-documentation, um eine OpenAPI-Spezifikation für meine API zu erstellen. Die API verwendet JWT-Authentifizierung und umfasst Endpoints für Benutzer, Produkte und Bestellungen.
Verwende den @api-documentation Workflow, um Code-Beispiele zu meiner bestehenden API-Dokumentation hinzuzufügen. Ich benötige Beispiele in Python, JavaScript und cURL.
Verwende @api-documentation, um interaktive Dokumentation mit Swagger UI und Redoc für meine bestehende OpenAPI-Spezifikation einzurichten. Konfiguriere die Try-it-Funktionalität.
Bonnes pratiques
- Beginne mit API-Discovery, um alle Endpoints zu verstehen, bevor du Dokumentation generierst
- Halte OpenAPI-Spezifikationen mit tatsächlichen API-Änderungen durch Automatisierung synchron
- Teste alle Code-Beispiele, um sicherzustellen, dass sie in Produktivumgebungen funktionieren
Éviter
- Die Discovery-Phase überspringen und direkt zur Dokumentationsgenerierung übergehen
- Dokumentation generieren, ohne die Genauigkeit der API-Spezifikationen zu überprüfen
- Statische Dokumentation erstellen, die nie aktualisiert wird, wenn sich APIs ändern