mcpField
A
api-documentation-writer

api-documentation-writer

github.com/onewave-ai開発393373 回インストール1 週間前に更新
リポジトリ

api-documentation-writer について

開発者向けの包括的なAPIドキュメントを作成するスキルです。REST、GraphQLなどのAPIについて、情報整理から例、エラー、制限、品質確認までを支援します。

主な機能

  1. 01API情報の収集
  2. 02構成に沿ったドキュメント作成
  3. 03RESTとGraphQLの例
  4. 04エラーとレート制限の説明
  5. 05curl、JavaScript、Pythonのサンプル
  6. 06ドキュメント品質チェックリスト

活用シーン

  1. 01RESTエンドポイントの文書化
  2. 02OpenAPI仕様の作成
  3. 03GraphQLスキーマの説明
  4. 04Webhookや認証ガイドの作成

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/onewave-ai/claude-skills --skill api-documentation-writer

インストール後、Claude Code で/api-documentation-writerを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
best-practices.md
documentation-structure.md
output-template.md

詳細

API ドキュメントライター

包括的で開発者に使いやすい API ドキュメントを生成します。

内容

  • references/documentation-structure.md — 説明する各セクション（概要、認証、エンドポイント、エラー、レート制限、SDK、Webhook、GraphQL）
  • references/output-template.md — 実例付きの標準 REST Markdown テンプレート
  • references/best-practices.md — ベストプラクティス、開発者体験向上のヒント、出力品質チェックリスト

ワークフロー

  1. API 情報を収集します。API の種類（REST、GraphQL、WebSocket、gRPC）、認証方式（API キー、OAuth、JWT）、ベース URL とバージョニング戦略、利用可能なエンドポイントとその用途、リクエスト／レスポンス形式、レート制限や利用上の制約を確認します。

  2. ドキュメントの構成を作成します。references/documentation-structure.md のすべてのセクションを含め、よく利用される操作から順に並べます。

  3. 出力を生成します。REST API では references/output-template.md に従い、GraphQL ではスキーマ、クエリ、ミューテーション、サブスクリプションの例に合わせて調整します。すべてのプレースホルダーを現実的なサンプルデータに置き換え、リクエストとレスポンスの両方を示します。

  4. エラーとレート制限を記載します。標準的なエラーレスポンス形式、一般的なエラーコード、トラブルシューティングのガイダンス、制限、確認すべきヘッダー、429 レスポンスの処理方法を含めます。

  5. 複数の言語（curl、JavaScript、Python）でコードサンプルを提供し、利用できる場合は SDK、Postman コレクション、OpenAPI 仕様へのリンクを記載します。

  6. 提供する前に、references/best-practices.md のチェックリストに照らして品質を確認します。

使用例

  • 「自分の REST エンドポイントの API ドキュメントを書いて」
  • 「自分の API の OpenAPI 仕様を作成して」
  • 「この GraphQL スキーマをドキュメント化して」
  • 「自分の Webhook API の開発者向けドキュメントを生成して」
  • 「API の認証ガイドを書いて」

コメント

Markdown 対応