認証はAPIテストと開発において重要な要素です。認証状態を適切に管理することで、APIリクエストが安全で効率的になり、実際の使用シナリオを正確に反映できます。このガイドでは、強力なAPI開発およびテストプラットフォームであるApidogでの認証状態の取り扱いに焦点を当てます。このガイドは、Apidog内で認証状態を効果的に管理するのに役立ちます。一般的な認証方法#
1. セッション/クッキー方式#
Apidogはセッションとクッキーを通じて自動的に認証状態を維持します。ログインAPIを実行すると、グローバルCookieに返されたセッション/クッキー情報が保存されます。
後続のAPI呼び出しには、このセッション/クッキー情報が自動的に含まれます。
セッション/クッキーによる自動ログインの実装については、以下の「自動ログインの実装」セクションを参照してください。
2. トークンベース認証#
トークンベース認証では、APIリクエストのパラメータ（通常はHeader）にログイン認証情報を含めます。一般的な方法には、Basic Auth、Bearer Token、API Keyなどがあります。1.
認証情報をグローバル（プロジェクト概要ページ）、グループレベル（グループ設定）、または個々のAPI（ドキュメントページ）で設定します。サポートされている認証タイプは以下の通りです： 2.
トークンをHeaderや他の関連パラメータに手動で追加します。トークンの保存には環境変数の使用を推奨します。例：Bearer Token: Authorizationという名前のHeaderを設定し、値にBearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9yJpZCI6を指定するか、環境変数を使用します：Bearer {{AUTH_TOKEN}}。
3.
グローバルパラメータに値を設定します。すべてのAPIは実行時に自動的にグローバルパラメータを含むため、APIごとに手動で設定する必要はありません。
トークンによる自動ログインの実装については、以下の「自動ログインの実装」セクションを参照してください。
3. 自動ログイン方式#
この方法では、手動での介入なしにログインAPIを自動的に呼び出して認証を完了します。自動ログインの実装#
期待される結果#
1.
手動での介入なしにログインAPIが自動的に呼び出される。
2.
ログイン成功後に認証状態が保持され、冗長なログインAPI呼び出しを避ける。
ステップバイステップガイド#
1.
環境変数（例：ACCESS_TOKEN）を使用してログイン認証情報を保存します。
2.
認証情報に有効期限がある場合、環境変数（例：ACCESS_TOKEN_EXPIRES）を使用してこの情報を保存します。
3.
以下の内容のパブリックスクリプトを作成します：
a. ACCESS_TOKENに値があり、ACCESS_TOKEN_EXPIRESがまだ有効かどうかを確認します。有効であれば実行を続行し、そうでなければ次のステップに進みます。
b. pm.sendRequestを使用してログインAPIを呼び出し、返された認証情報と有効期限を環境変数に書き込みます。
4.
認証が必要なAPIを設定します：
a. 認証検証パラメータを{{ACCESS_TOKEN}}に設定します。Authorizationヘッダーを{{ACCESS_TOKEN}}に設定するか、必要に応じてクッキーや他のパラメータを使用します。
または、グローバルパラメータに値を設定して、すべてのAPI呼び出しに自動的に含まれるようにします。
b. 上記で作成したパブリックスクリプ トを前処理スクリプトで参照します。
パブリックスクリプトの例#
このスクリプトのログイン認証情報は、LOGIN_USERNAMEとLOGIN_PASSWORD環境変数から取得されます。このコードを使用する場合は、これらの環境変数を設定してください。
トークンに有効期限がない場合は、ACCESS_TOKEN_EXPIRES関連のコードを削除してください。
