api-documentation

APIドキュメント

サービスAPI文書の作成・編集・再構成・レビューを支援し、契約に沿って操作、入出力、エラー、型、ルート、例を明確に整理します。

AIスキル大辞典による日本語要約
品質評価88/100評価確度:標準
人気度(GitHub Star) 16発掘スコア 98
01

このSkillでできること

  • API仕様書の作成、編集、再構成、レビュー
  • 操作、リクエスト、レスポンス、エラー、型、ルート、例の整理
  • 権威ある契約やスキーマに基づくAPI文書の整合性確認
  • 認証、ヘッダー、ページネーション、冪等性、バージョニングなどの規約整理
02

使い方

01
STEP 1

既存文書と、OpenAPI、スキーマ、実装、テストなどの権威ある情報源を確認する

02
STEP 2

APIのバージョン、対象サービス、通信方式、認証、対象読者、変更範囲を明確にする

03
STEP 3

各操作を安定したルート見出しとRequest、Response、Errorsの構成で記述する

04
STEP 4

不明点や情報源間の不一致は推測で補わず、未決定または競合として明示する

03

Skillのインストール

このGitHubリポジトリにあるSkillを確認し、現在の環境に適した方法でインストールしてください。
インストール後、正常に利用できることを確認し、基本的な使い方も簡潔に説明してください。

Repository:
https://github.com/sandbaseai/workbuddy-skill
04

このSkillを使うプロンプト例

Skill名を明示すると、意図したSkillを使わせやすくなります。自動発動型では必須とは限りません。

既存のAPI文書と提供されたAPI契約を比較し、契約にないルートやフィールドを追加せず、操作ごとにRequest、Response、Errorsを明確に整理してください。認証、型、必須・任意、エラー、例の不整合も指摘してください。
出力例を見る
## `GET /resources/{id}`\n\n### Request\n\n### Response\n\n### Errors\n\n契約に記載された内容のみを使用し、不明な項目は未決定として示します。
05

安全性チェック

自動解析による参考情報です。Skillの安全性を保証するものではありません。

外部API通信検出あり
Shellコマンド実行検出あり
ファイル読み取り明確な記述なし
ファイル書き込み明確な記述なし
ネットワークアクセス検出あり
認証情報検出あり
検出根拠を見る
  • shell: logy drift, du […truncated…] producibility matters: ```bash gh skill preview sandbaseai/workbuddy-skill skills/oss-review release_tag="$(gh release v
  • network: s still in preview. Check the [current command manual](https://cli.github.com/manual/gh_skill_install) for supported agents and scopes; use `--dir` when
  • network: iewed workflow. Further reading: the [WorkBuddyGuide](https://github.com/AlephAITech/WorkBuddyGuide) is a task-oriented community guide, while [Tencent
  • credential: ing reviewed package improvements. Please never commit API keys, access tokens, private prompts, or customer data. For help, see [SUPPORT.md](SUPPORT.m
06

関連Skill