api-doc-generator
APIドキュメントの生成
手作業のAPIドキュメントはコードに追いつかず、開発者に混乱をもたらします。このスキルは、利用可能なコードやエンドポイントの詳細から、OpenAPIのドラフト、リクエスト例、Postmanコレクション向けのガイダンスを作成するのに役立ちます。
自分のエージェントでインストール
このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。
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.エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。
エージェントが読めるリソース
AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。
テストする
「api-doc-generator」を使用しています。 ユーザーサービスにcreate user、get user、update user、delete userのエンドポイントがあります。
期待される結果:
エンドポイント概要、リクエストフィールド、レスポンス例、ステータスコード、OpenAPI対応セクションを含む構造化されたAPIリファレンス。
「api-doc-generator」を使用しています。 チームにはルートコードがありますが、パートナー向けの統合ドキュメントがありません。
期待される結果:
認証の前提、リクエスト例、期待されるレスポンス、Postmanコレクションの整理方法を説明する明確な統合ドラフト。
「api-doc-generator」を使用しています。 既存のAPI仕様に、最近追加されたルートが不足している可能性があります。
期待される結果:
不足しているエンドポイント、不完全なスキーマ、不明確な例、推奨されるドキュメント更新を列挙した網羅性レビュー。
セキュリティ監査
安全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.
このレポートを共有・引用
バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。
レポートリンクをコピー
https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdownバッジ
[](https://skillstore.io/skills/zhangchenlai-dev-api-doc-generator?utm_source=security_passport_badge)HTMLバッジ
<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>埋め込みカード
<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>学術引用 (APA · BibTeX · CFF)
APA形式の引用
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/5BibTeX形式の引用
@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 スコア
このスコアの理由 証拠の信頼度: 中作成できるもの
新しいサービスをドキュメント化する
ルートハンドラーとスキーマメモから、APIリファレンス内容の初稿を生成します。
統合ガイドを準備する
エンドポイントの詳細を、外部パートナー向けの明確なリクエスト例に変換します。
チームのAPI仕様を標準化する
散在するエンドポイントメモを、一貫したOpenAPI指向の構造に変換します。
これらのプロンプトを試す
これらのエンドポイントのAPIドキュメントを生成してください。method、path、purpose、parameters、request examples、response examplesを含めてください。
このAPIコードをレビューし、paths、methods、request bodies、response schemas、common errorsを含むOpenAPI 3.0アウトラインを作成してください。
このエンドポイントドキュメントをPostmanコレクション向けのガイダンスに変換してください。folders、request names、headers、variables、example bodiesを含めてください。
これらのルートを現在のAPIドキュメントと比較してください。不足しているエンドポイント、不明確なスキーマ、一貫性のない例、古くなったレスポンス説明を特定してください。
ベストプラクティス
- ルートコード、スキーマ定義、認証の詳細をまとめて提供してください。
- 実際のリクエストとレスポンスの形状に一致する例を求めてください。
- 生成されたOpenAPIコンテンツは、顧客と共有する前にレビューしてください。
回避
- 生成された仕様を実装と照合して検証せずに公開しないでください。
- 認証、エラー処理、レート制限のコンテキストを省略しないでください。
- プレースホルダーの例を本番環境の契約詳細として扱わないでください。
よくある質問
このスキルはOpenAPI 3.0ドキュメントを作成できますか？
Postmanコレクションを直接作成できますか？
ライブAPIを検査しますか？
どのような入力が最適ですか？
英語以外のチームにも役立ちますか？
生成されたドキュメントは最終版ですか？
開発者情報
ライセンス
MIT
作者バージョン
v1.0.0
Skillstore リビジョン
r1
参照
64ca8af0f54a325752f08bd54e52151061ea659a
メンテナンスの新しさ
2026/7/22
利用状況
3 ダウンロード · 1 閲覧
ファイル構成
📄 SKILL.md