OpenAPI を購読してオンラインでテストする方法
Rock API では、購入者が OpenAPI サービスを購読し、統合コードを書く前にオンラインでリクエストをテストできます。このガイドは RockAPI の動画 How to use normal openapi? の流れに対応しています。
最終更新日: 2026 年 5 月 23 日
この手順の目的
アプリケーションに接続する前に、外部 OpenAPI サービスを評価したいときに使います。オンラインテストにより、ローカルクライアントを用意する前に、認証、リクエストパラメーター、レスポンス項目、エラー処理を確認できます。ステップ 1: OpenAPI サービスを選ぶ
API 詳細ページで、本番利用に必要な情報を確認します。- API が何を行い、どのユースケースをサポートするか。
- 購読に含まれるエンドポイント。
- 価格、クォータ、レート制限の仕組み。
- ドキュメントにリクエストとレスポンスの例があるか。
- 購読後に必要な認証方式。
ステップ 2: API を購読する
サービスを選んだら、API 詳細ページから購読します。確定前に、選択したプラン、請求条件、利用制限を確認してください。 購読が有効になると、Rock API はその API へのオンラインテスト呼び出しとアプリケーション呼び出しを認可できます。テストと本番のトラフィックが混ざらないよう、購読と API キーを正しいプロジェクトまたは環境に紐づけます。ステップ 3: オンラインテストコンソールを開く
API ドキュメント内のオンラインテスト領域を使い、ブラウザからリクエストを送信します。最初は最も単純なエンドポイントを選び、基本リクエストが成功してから任意パラメーターを追加します。 送信前に確認する項目:- HTTP メソッドとエンドポイントパス。
- 認証を含む必須ヘッダー。
- 必須 query パラメーターまたは JSON body フィールド。
- ドキュメントのサンプル値。
ステップ 4: レスポンスを読む
オンラインテストが成功すると、ドキュメントと一致するステータスコードとレスポンス本文が返ります。アプリが依存する ID、ステータス値、ページネーション項目、結果 URL などを確認します。 テストが失敗した場合は、エラーレスポンスから原因を切り分けます。ステップ 5: オンラインテストからコードへ移す
ブラウザでのテストが成功したら、確認済みのリクエスト形式をアプリケーションに移します。次の情報を同じにします。- Base URL とエンドポイントパス。
- HTTP メソッド。
- ヘッダーと認証形式。
- JSON body のフィールドとデータ型。
- 想定する成功レスポンスとエラーレスポンス。
購入者チェックリスト
- API の価格、クォータ、レート制限を理解している。
- 意図したアカウントまたはプロジェクトで購読した。
- オンラインテストで有効なレスポンスを確認した。
- 開発者向けに動作するリクエスト例を保存した。
- アプリケーションが処理すべきエラーを把握している。
- 本番前に API キー管理 を確認した。
よくある質問
購読後に OpenAPI を最速でテストする方法は何ですか？
API ドキュメント内のオンラインテストコンソールを使う方法が最速です。ブラウザからリクエストを送り、ステータスコード、レスポンス本文、エラー詳細を確認できます。API をテストする前にコードを書く必要はありますか？
いいえ。まずオンラインテストコンソールを使えます。テストが成功したら、同じエンドポイント、ヘッダー、本文を curl、Node.js、Python、またはアプリケーションコードへ移します。オンライン API テストで 401 または 403 が返る理由は何ですか？
401 または 403 は、多くの場合リクエストが認可されていないことを示します。購読が有効か、API キーが正しいか、必要な認証ヘッダーがあるかを確認してください。