Fähigkeiten api-doc-generator

📦

api-doc-generator

Name: api-doc-generator
Author: Hermes-Sedimentary

v1.0.0 Inhaltsrevision r1 Sicher

API-Dokumentation generieren

Manuelle API-Dokumentation hinkt dem Code hinterher und sorgt bei Entwicklern für Verwirrung. Diese Skill hilft dabei, OpenAPI-Entwürfe, Request-Beispiele und Anleitung für Postman Collections aus verfügbarem Code oder Endpoint-Details zu erstellen.

Unterstützt: Claude Codex Code(CC)

🥈 80 Silber

Mit meinem Agent installieren

Kopieren Sie diese Anfrage in Ihren Agent. Sie enthält die maßgebliche Skill-Seite und das Manifest.

Agent-Anfrage

Review the Skillstore skill "api-doc-generator" from https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator.md and its manifest at https://skillstore.io/api/skills/zhangchenlai-dev-api-doc-generator/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

Ihr Agent sollte weiterhin seinen Plan anzeigen und alle von der Sicherheitsrichtlinie verlangten Bestätigungen anfordern.

Agent-lesbare Ressourcen

Verwenden Sie diese Links, wenn ein KI-Agent, Crawler oder Skript sauberen Kontext benötigt, statt die vollständige Seite zu lesen.

Markdown-Detailseite GET /skills/zhangchenlai-dev-api-doc-generator.md Signiertes manifest GET /api/skills/zhangchenlai-dev-api-doc-generator/manifest Signiertes lockfile GET /api/skills/zhangchenlai-dev-api-doc-generator/lockfile

Testen

„api-doc-generator“ wird verwendet. Ein User-Service hat Endpoints zum Erstellen, Abrufen, Aktualisieren und Löschen von Benutzern.

Erwartetes Ergebnis:

Eine strukturierte API-Referenz mit Endpoint-Zusammenfassungen, Request-Feldern, Response-Beispielen, Statuscodes und OpenAPI-fähigen Abschnitten.

„api-doc-generator“ wird verwendet. Ein Team hat Route-Code, aber keine partnerorientierte Integrationsdokumentation.

Erwartetes Ergebnis:

Ein klarer Integrationsentwurf, der Authentifizierungsannahmen, Request-Beispiele, erwartete Antworten und die Organisation einer Postman Collection erklärt.

„api-doc-generator“ wird verwendet. In einer bestehenden API-Spezifikation fehlen möglicherweise kürzlich hinzugefügte Routen.

Erwartetes Ergebnis:

Eine Abdeckungsprüfung mit fehlenden Endpoints, unvollständigen Schemas, unklaren Beispielen und empfohlenen Dokumentationsaktualisierungen.

Sicherheitsaudit

Sicher

v5 • 8.7.2026 Versionsbericht öffnen

The only static finding was a high-entropy heuristic on SKILL.md. Manual review found plain Markdown skill metadata and usage notes, with no obfuscation, prompt injection, exfiltration intent, or dangerous actions.

Gescannte Dateien

Analysierte Zeilen

Prüfelemente

Falschmeldungen ignoriert

Das letzte abgeschlossene statische und semantische Audit erkannte keine bestätigten Sicherheitsbefunde. Dies beweist nicht, dass der Skill keine Nebenwirkungen hat.

Geprüft von: codex Audit-Verlauf anzeigen →

Diesen Bericht teilen & zitieren

Teile den versionierten Bewertungsbericht, das neutrale Badge, die Einbettungskarte und Zitate. Skillstore berichtet Nachweise, ohne zu entscheiden, ob dieser Skill sicher ist.

Versionsbericht öffnen

Berichtslink kopieren

https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdown-Badge

[![Skillstore security assessment](https://skillstore.io/badges/skills/zhangchenlai-dev-api-doc-generator/security.svg)](https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator?utm_source=security_passport_badge)

HTML-Badge

<a href="https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/zhangchenlai-dev-api-doc-generator/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

Einbettungskarte

<iframe src="https://skillstore.io/embed/skills/zhangchenlai-dev-api-doc-generator.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>

Wissenschaftliche Zitate (APA · BibTeX · CFF)

APA-Zitat

Hermes-Sedimentary. (2026). api-doc-generator security audit report (audit version 5) [Author version 1.0.0]. Skillstore. https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5

BibTeX-Zitat

@techreport{hermes-sedimentary-zhangchenlai-dev-api-doc-generator-2026,
  author = {Hermes-Sedimentary},
  title = {api-doc-generator security audit report (audit version 5)},
  institution = {Skillstore},
  year = {2026},
  number = {5},
  url = {https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5},
  note = {Author version 1.0.0}
}

CITATION.cff

cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "api-doc-generator security audit report (audit version 5)"
version: "1.0.0"
type: report
authors:
  - name: "Hermes-Sedimentary"
date-released: "2026-07-08"
url: "https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5"
identifiers:
  - type: other
    value: "skillstore:zhangchenlai-dev-api-doc-generator:audit:5"
    description: "Skillstore immutable audit report identifier"

Skillstore-Score

Warum dieser Score Evidenzvertrauen: Mittel

Architektur

100

Wartbarkeit

Inhalt

Gemeinschaft

Spezifikationskonformität

Was Sie erstellen können

Einen neuen Service dokumentieren

Erstelle einen ersten Entwurf für API-Referenzinhalte aus Route-Handlern und Schema-Notizen.

Integrationsleitfäden vorbereiten

Wandle Endpoint-Details in klare Request-Beispiele für externe Partner um.

API-Spezifikationen im Team standardisieren

Konvertiere verstreute Endpoint-Notizen in eine konsistente, an OpenAPI orientierte Struktur.

Diese Prompts ausprobieren

Grundlegende Endpoint-Dokumentation erstellen

Generiere API-Dokumentation für diese Endpoints. Schließe Methode, Pfad, Zweck, Parameter, Request-Beispiele und Response-Beispiele ein.

Eine OpenAPI-Gliederung erstellen

Prüfe diesen API-Code und erstelle eine OpenAPI 3.0-Gliederung mit Pfaden, Methoden, Request Bodies, Response-Schemas und häufigen Fehlern.

Postman-Anleitung vorbereiten

Konvertiere diese Endpoint-Dokumentation in eine Anleitung für eine Postman Collection. Schließe Ordner, Request-Namen, Header, Variablen und Beispiel-Bodies ein.

Dokumentationsabdeckung prüfen

Vergleiche diese Routen mit der aktuellen API-Dokumentation. Identifiziere fehlende Endpoints, unklare Schemas, inkonsistente Beispiele und veraltete Response-Beschreibungen.

Bewährte Praktiken

Stelle Route-Code, Schema-Definitionen und Authentifizierungsdetails gemeinsam bereit.
Fordere Beispiele an, die den tatsächlichen Request- und Response-Strukturen entsprechen.
Prüfe generierte OpenAPI-Inhalte, bevor du sie mit Kunden teilst.

Vermeiden

Veröffentliche keine generierten Spezifikationen, ohne sie gegen die Implementierung zu validieren.
Lasse Kontext zu Authentifizierung, Fehlerbehandlung oder Rate Limits nicht aus.
Behandle Platzhalterbeispiele nicht als Details eines Produktionsvertrags.

Häufig gestellte Fragen

Kann diese Skill ein OpenAPI 3.0-Dokument erstellen?

Ja. Sie kann OpenAPI-artige Abschnitte aus Code oder Endpoint-Beschreibungen entwerfen, aber ein Entwickler sollte das Ergebnis validieren.

Kann sie Postman Collections direkt erstellen?

Sie kann Anleitung für Postman Collections und Request-Organisation vorbereiten. Importfähige Ausgabe kann manuelle Formatierung erfordern.

Untersucht sie eine Live-API?

Nein. Die Skill beschreibt Dokumentationsarbeit und testet Live-Endpoints nicht selbst.

Welche Eingaben funktionieren am besten?

Route-Handler, Methoden- und Pfadlisten, Schema-Definitionen, Beispiel-Payloads und Authentifizierungsnotizen funktionieren am besten.

Ist sie für nicht englischsprachige Teams nützlich?

Ja. Die Quellbeschreibung ist Chinesisch, und Benutzer können Dokumentation in ihrer bevorzugten Sprache anfordern.

Ist die generierte Dokumentation final?

Nein. Generierte Dokumentation sollte auf Genauigkeit, Sicherheitsdetails und versionsspezifisches Verhalten geprüft werden.

Entwicklerdetails

Autor

Hermes-Sedimentary

Lizenz

MIT

Autorenversion

v1.0.0

Skillstore-Revision

Repository

https://github.com/zhangchenlai-dev/hermes-skill-store/tree/master/api-doc-generator

Ref.

64ca8af0f54a325752f08bd54e52151061ea659a

Aktualität der Wartung

20.7.2026

Nutzung

2 Downloads · 1 Aufrufe

Dateistruktur

📄 SKILL.md