Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. ベストプラクティス
  • Apidog学習センター
  • はじめに
    • Apidog紹介
    • Apidog基本操作
      • 概要
      • 新しい APIを作成
      • APIにリクエストを送信
      • アサーションを追加
      • テストシナリオを作成
      • APIドキュメントを共有
      • さらなる探究
      • リクエストを送信してAPIとして保存
    • Apidog基本知識
      • Apidog操作方法
      • Apidogの基本概念
    • 移行
      • 概要
      • 手動インポート
      • 定期インポート
      • インポートオプション
      • データのエクスポート
      • Import from...
        • Postman からインポート
        • OpenAPI(Swagger)仕様のインポート
        • cURLのインポート
        • Markdownのインポート
        • Insomniaからのインポート
        • apiDocからのインポート
        • .harファイルのインポート
        • WSDLのインポート
  • API設計
    • 概要
    • コンポーネント
    • 常用フィールド
    • グローバルパラメータ
    • API変更履歴
    • プロジェクトの作成
    • 一括API管理
    • APIの基本
    • 複数のリクエストボディ例の設定
    • Schemas
      • 概要
      • 新規Schemaの作成
      • スキーマを構築する
      • JSONなどからのSchema生成
    • Security schemes
      • 概要
      • Security Schemeの作成
      • Security Schemeの使用
      • オンラインドキュメントにおけるSecurity Scheme
    • 高度な機能
      • APIをテストステップとしてインポート
      • パラメータリストの表示形式
      • APIのカスタムフィールド
      • APIのステータス
      • API固有識別子
  • API開発とデバッグ
    • 概要
    • リクエストの生成
    • リクエストの送信
    • コード生成機能
    • APIケース
    • 動的な値
    • レスポンスの検証
    • 設計優先 & リクエスト優先
    • 環境 & 変数
      • 概要
      • 環境とサービス
      • 変数の使い方
    • Vault secrets
      • 概要
      • AWS Secrets Manager
      • Azure Key Vault
      • HashiCorp Vault
    • 前/後処理
      • 概要
      • Wait
      • 変数の抽出
      • アサーション
      • データベース操作
        • 概要
        • MongoDB
        • Redis
        • Oracle クライアント
      • スクリプト利用
        • 概要
        • 前処理スクリプト
        • 後処理スクリプト
        • Postmanスクリプトリファレンス
        • 共通スクリプト
        • 他のプログラミング言語の呼び出し
        • JSライブラリの使用
        • レスポンスの可視化
        • スクリプトの例
          • その他の例
          • スクリプトを使用したリクエストメッセージの変更
          • スクリプトでの変数の使用
          • アサーションスクリプト
    • 動的値モジュール
  • APIモック
    • 概要
    • スマートMock
    • カスタムMock
    • Mockの優先順位
    • Mockスクリプト
    • クラウドMock
    • セルフホストランナーMock
    • Mock言語 (ロケール)
  • 自動テスト
    • 概要
    • テストレポート
    • テストシナリオ
      • テストシナリオの作成
      • 他のプロジェクトからAPI/APIケースをインポートする
      • リクエスト間でデータを渡す
      • API/APIケースからのデータ同期
      • フロー制御条件
      • テストシナリオのエクスポート
    • テストシナリオ実行
      • データ駆動型テスト
      • スケジュールタスク
      • テストシナリオを一括実行する
      • 他のプロジェクトのAPIの実行環境を管理する
      • テストシナリオを実行する
    • APIテスト
      • 統合テスト
      • 回帰テスト
      • エンドツーエンド(E2E)テスト
      • パフォーマンステスト
    • Apidog CLI
      • 概要
      • Apidog CLIのインストールと実行
      • Apidog CLI オプション
    • CI/CD
      • 概要
      • Jenkinsとの連携
      • Gitlabとの統合
  • APIドキュメント公開
    • 概要
    • Google AnalyticsとDoc Sitesの連携
    • CORS プロキシ
    • クイック共有
    • 可視性設定
    • ドキュメントURLに値を埋め込む
    • APIドキュメントを表示する
    • フォルダツリー設定
    • API SEO設定
    • カスタムレイアウト
    • ドキュメント検索
    • カスタムドメイン
    • ドキュメントサイトの公開
    • APIバージョン
      • 概要
      • APIバージョンの作成
      • APIバージョンの公開
      • APIバージョンごとにAPIの共有
  • リクエスト送信
    • 概要
    • GraphQL
    • gRPC
    • WebSocket
    • SSEデバッグ
    • SOAP/Webサービス
    • デバッグ用のリクエストプロキシエージェントを使用する
    • Socket.IO
    • リクエスト作成
      • リクエストの基本
      • パラメータとボディ
      • リクエストヘッダー
      • リクエスト設定
      • HTTP/2
      • リクエスト履歴
    • 認証と認可
      • 概要
      • CAとクライアント証明書
      • Apidogがサポートする認可タイプ
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • レスポンスとクッキー
      • 概要
      • ApidogのAPIレスポンス
      • Cookieの作成と送信
      • リクエストのデバッグ
      • リクエストをAPIとして保存
  • ブランチ管理
    • 概要
    • 新しいスプリントブランチの作成
    • スプリントブランチの管理
    • ブランチ内でのAPIテスト
    • ブランチでAPIの設計
    • スプリントブランチのマージ
  • Apidog MCP Server
    • 概要
    • Apidogプロジェクト内のAPI仕様をApidog MCPサーバー経由でAIに接続する
    • Apidogが公開したオンラインAPIドキュメントをApidog MCPサーバー経由でAIに接続する
    • Apidog MCPサーバーを介してOpenAPIファイルをAIに接続する
  • ベストプラクティス
    • ガイド:ChatGPT APIのトークンとコスト計算
    • Apidog コラボレーションワークフロー
    • API署名の取り扱い方法
    • Apidogでの認証状態の管理
    • OAuth 2.0で保護されたAPIにアクセスする方法
  • 管理
    • オンボーディングチェックリスト
      • 基本概念
      • Apidogスタートアップガイド
    • チーム管理
      • チーム管理
      • チームメンバーの管理
      • メンバーの役割と権限設定
      • チーム活動
      • チームリソース
        • 一般ランナー
        • チーム変数
        • リクエストプロキシエージェント
        • データベース接続
      • リアルタイムコラボレーション
        • チームコラボレーション
    • プロジェクト管理
      • プロジェクト管理
      • プロジェクトメンバーの管理
      • 通知設定
    • 組織管理
      • シングルサインオン(SSO)
        • 概要
        • Microsoft Entra IDの設定
        • Okta設定
        • 組織のSSOを設定する
        • チームへのグループのマッピング
        • ユーザーアカウントの管理
      • SCIMプロビジョニング
        • SCIMプロビジョニング入門
        • Microsoft Entra ID
        • Okta
      • 組織リソース
        • セルフホストランナー
  • 請求情報
    • 概要
    • プランのアップグレード
    • クレジット
    • クレジットカードが使えない?
    • サブスクリプションの管理
  • アドオン
    • API Hub
    • Apidog IntelliJ IDEA プラグイン
    • リクエストプロキシ
      • Apidogウェブでのリクエストプロキシ
      • 共有ドキュメントでのリクエストプロキシ
      • Apidogクライアントでのリクエストプロキシ
    • ブラウザ拡張機能
      • Microsoft Edge
      • Chrome
  • アカウント & 設定
    • アカウント設定
    • 言語設定
    • データバックアップ
    • ネットワークプロキシ設定
    • ホットキー
    • Apidogの更新
    • OpenAPIアクセストークンの生成
    • アカウント削除
  • 参考資料
    • Swagger拡張機能
    • Socket通信:パケットの分断と結合
    • 用語の説明
    • よくある質問
    • API-デザインファーストアプローチ
    • Apidog OpenAPI/Swagger仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSONスキーマ
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
  1. ベストプラクティス

OAuth 2.0で保護されたAPIにアクセスする方法

OAuth 2.0は、ユーザーがGoogleやGitHubなどのサードパーティアプリケーションに、自分に代わってサービスへのアクセスや登録を許可するための認証フレームワークです。これにより、ユーザーはWeb登録時に繰り返し情報を入力する必要がなくなり、サードパーティ認証ログインを利用する際の個人データのセキュリティと柔軟性が確保されます。
この記事では、Googleアカウントでのサインインと認証を例に、Apidogを使用してOAuth 2.0 APIをデバッグする方法を紹介します。

はじめに#

Googleアカウントを使用して認証を行うウェブサイトが開発されたとします。この設定では、ウェブサイトがクライアントとして機能し、Googleが認証サーバーとなります。ウェブサイト内でGoogle OAuth 2.0を統合するには、以下の手順に従う必要があります。
Google API Console Projectを登録していない場合は、公式ドキュメントを参照して新しいOAuthクライアントを作成してください。

1. ウェブページがGoogleにユーザー認証をリクエストする#

ユーザーが「Googleでサインイン」ボタンをクリックすると、ウェブサイトはGoogleのOAuth 2.0認証サーバーにリクエストを送信し、ユーザーのGoogleアカウントへのアクセス許可を取得します。
リクエストページのURLはhttps://accounts.google.com/o/oauth2/v2/auth/です。公式ドキュメントに基づき、リクエストには以下のパラメータを含める必要があります。
パラメータ説明
client_id必須、アプリケーションのクライアントID。API ConsoleのCredentialsページで確認できます。
redirect_uri必須、認証フロー完了後にAPIサーバーがユーザーをリダイレクトする場所。OAuth 2.0クライアントの認可済みリダイレクトURIと完全に一致する必要があります。
response_type必須、Google OAuth 2.0 APIが認証コードを返すかどうかを決定します。Webサーバーアプリケーションの場合は、パラメータ値をcodeに設定します。
scope必須、アプリケーションがユーザーの代わりにアクセスできるリソースを識別するスコープのリスト。これらの値は、Googleがユーザーに表示する同意画面に反映されます。
access_type推奨、ユーザーがブラウザにいない場合にアプリケーションがアクセストークンを更新できるかどうかを示します。有効なパラメータ値は、デフォルト値のonlineとofflineです。
state推奨、認証リクエストと認証サーバーの応答間で状態を維持するためにアプリケーションが使用する任意の文字列値。
INFO
この形式は、Google OAuth 2.0に必要な基本的なパラメータを示しています。ユーザーエクスペリエンスやアプリケーションのセキュリティをカスタマイズするために、他にも多くのオプションパラメータがあります。詳細は公式ドキュメントを参照してください。

2. ユーザーがアプリケーションを認可する#

ユーザーがアカウント情報を入力すると、Googleは指定されたリソースへのアクセス許可を求める同意画面を表示します。ユーザーがリクエストを承認すると、Googleは認証トークンをWebサーバーに送信します。ユーザーがリクエストを拒否すると、GoogleはエラーメッセージをWebサーバーに返します。
ユーザーがアプリケーションを認可する

3. ウェブページがGoogleにアクセストークンをリクエストする#

ユーザーが許可を承認すると、Googleから認証トークンが送信され、レスポンスに含まれます。ユーザーがリクエストを承認しない場合、レスポンスにはエラーメッセージが含まれます。Webサーバーに返される認証コードまたはエラーメッセージは、以下のようにクエリ文字列に表示されます。
# エラー
http://example.com/#error=access_denied&state=state_parameter_passthrough_value

# 成功
http://example.com/#state=state_parameter_passthrough_value&access_token=***&token_type=Bearer&expires_in=***&scope=email%20https://www.googleapis.com/auth/userinfo.email%20openid&authuser=0&prompt=consent
URLからアクセストークンを抽出し、他のGoogle APIサービスにアクセスするために使用できます。

4. アクセストークンを送信してGoogle APIから情報を取得する#

「Openidconnect API」を例に、アクセストークンを使用して以下のURLにリクエストを送信し、ユーザーのGoogleアカウント情報にアクセスできます。
Apidogのプロジェクトで新しいリクエストを作成し、ターゲットURLを貼り付けてアクセストークンをパラメータに入力します。「送信」ボタンをクリックしてAPIのレスポンスを取得します。

5. Googleがアクセストークンを確認する#

アクセストークンが受信されると、Googleはその有効性を確認し、関連する認可されたクライアントを特定します。トークンが有効な場合、Googleはユーザー情報を返します。トークンが無効または期限切れの場合、Googleはエラーメッセージを返します。
ご覧の通り、APIのレスポンスはJSONオブジェクトで、ユーザーのGoogleアカウントのpictureとemailが含まれています。ウェブサイトはこのデータを使用して、ユーザーのプロフィール画像とメールアドレスを自動的に表示し、手動での入力を不要にすることができます。

結論#

この記事では、Apidogを使用してGoogleのOAuth 2.0 APIをリクエストする方法を5つのステップで説明しました。
Apidogを使用してOAuth 2.0 APIをデバッグすることで、上流と下流のプロセスで必要なパラメータをより明確に可視化し、開発体験を最適化できます。完全なワークフローが正常に実行されると、バックエンド開発者はコードを書き始めて、開発中に検証する必要なく、ビジネスプロセス全体を完了できます。

参考文献#

Google OAuth 2.0 ドキュメント
この例で使用したウェブページのソースコード。
1.
HTML
2.
JavaScript
Previous
Apidogでの認証状態の管理
Next
基本概念
Built with