Shogun Labs API仕様リサーチ — 公式資料から実装用の仕様メモを作成

Shogun Labs API仕様リサーチ — 公式資料から実装用の仕様メモを作成

外部 API の公式ドキュメント・OpenAPI/Swagger 仕様・SDK のサンプルから、エンドポイント・認証方式・リクエストとレスポンスの形式・レート制限・統合時の注意点を出典付きで整理し、資料に書かれた事実と未確認の点を分けた Markdown の調査メモにします。
#الهندسة#البحث
التقييم
مطلوب المزيد من التقييمات
المبيعات
0
كيفية الاستخدام
تنزيل

できること

外部 API やサードパーティのサービスについて、公式ドキュメント・OpenAPI/Swagger の仕様ファイル・SDK のサンプルを読み、統合の作業に必要な情報を1つの仕様メモにまとめます。エンドポイント、認証方式、リクエストとレスポンスの形式、レート制限、統合時の注意点を、出典を付けて記録します。

入力と出力

  • 入力: API の名前と、公式ドキュメント・仕様ファイル・SDK のサンプルのいずれか。
  • 出力: Markdown の API 調査レポート。資料に書かれた事実と、答えの出ていない点を分けて書きます。エンドポイント・認証情報・レート制限・提供元の承認を推測で作りません。

使う場面

  • API を組み込む前の下調べ
  • 技術の選定や比較
  • 実装計画を立てる前の整理

ご注意

  • 実行するスクリプト・バックグラウンドの処理・外部への接続・認証情報は含みません。
  • API キーを Agent や資料に貼らないでください。認証の形式は説明しますが、実際の認証情報の保存・送信・生成はしません。
  • 公開されている資料か、使う許可のある資料だけを渡してください。
  • 出力は技術的な調べ物のまとめです。セキュリティ監査ではなく、本番環境での動作を保証するものでもありません。

What it does

Organizes official API documentation, OpenAPI or Swagger files, and SDK examples into an implementation-ready specification. It records endpoints, authentication, request and response formats, rate limits, and integration risks with source references.

Inputs and outputs

  • Input: an API name and official documentation, specification files, or SDK examples.
  • Output: a Markdown API research report. It separates documented facts from unanswered questions and does not invent endpoints, credentials, rate limits, or vendor approval.

Notes

  • No executable scripts, background tasks, external endpoints, or credentials are included.
  • Never paste API keys into the Agent or documentation.
  • The output is technical research, not a security audit or a guarantee of production compatibility.