OpenAPI と Postman

OpenAPI 3.1 仕様は、次の公開 URL から取得できます。

本番サーバー、認証方式、リクエストの検証条件、エンドポイントごとのレスポンススキーマ、エラー、利用制限ヘッダー、利用可能な API の例を含みます。言語を切り替えても、フィールド名、パス、JSON の例は共通です。

全リクエストを Postman にインポート

1. 全エンドポイントのコレクションをダウンロードします。
2. Postman の Import でファイルを読み込みます。OpenAPI の URL を Import → Link に貼り付ける方法も使えます。
3. キーをまだ持っていない場合は API キーを作成します。
4. コレクションの apiKey 変数を設定します。リクエストには X-API-Key 認証が継承されます。
5. エンドポイントを選び、JSON 本文を確認して送信します。HTTP ステータスを確認し、request_id を保存してください。

認証情報は Postman のローカル変数や安全な保存機能で管理してください。実際のキーが含まれるコレクションや環境ファイルを公開しないでください。

特定のエンドポイントだけをインポート

各 API のリファレンスページには、そのエンドポイント専用コレクションのダウンロード操作があります。特定のデータ取得を試したい場合、全体をインポートせずに検証できます。同じページでパラメーター、レスポンスのフィールド、curl・Node.js・Python の呼び出し例も確認できます。

クライアントの生成

OpenAPI 3.1 対応のクライアント生成ツール、バリデーター、テストツール、RapidAPI などに仕様をインポートできます。利用するツールの対応バージョンを確認してください。OpenAPI 3.0 のみ対応するツールでは、スキーマの解釈が異なる場合があります。

この仕様は機械可読な API 契約です。生成したクライアントを更新する際は、スキーマの差分を確認し、連携テストを実行してからデプロイしてください。API キーは生成コードに埋め込まず、サーバーの環境変数で管理します。

続いて認証、エラーと利用制限、API カタログを確認してください。