Apidog Docs
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
Home
Learning Center
Support Center
API References
Home
Learning Center
Support Center
API References
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
ベストプラクティス
Apidog学習センター
概要
概要
Apidog紹介
API設計者:APIの設計と公開
バックエンド開発者: APIのデバッグ
フロントエンド開発者: APIのモック
QAエンジニア: APIのテスト
リソース
はじめに
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生成
高度な機能
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スクリプト
自動テスト
概要
テストレポート
テストシナリオ
テストシナリオのエクスポート
他のプロジェクトから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の設定
組織のSSOを設定する
チームへのグループのマッピング
ユーザーアカウントの管理
SCIMプロビジョニング
SCIMプロビジョニング入門
Microsoft Entra ID
リソース
セルフホストランナー
請求情報
概要
プランのアップグレード
クレジット
クレジットカードが使えない?
サブスクリプションの管理
アドオン
API Hub
Apidog IntelliJ IDEA プラグイン
リクエストプロキシ
Apidogウェブでのリクエストプロキシ
共有ドキュメントでのリクエストプロキシ
Apidogクライアントでのリクエストプロキシ
ブラウザ拡張機能
Microsoft Edge
Chrome
アカウント & 設定
アカウント設定
言語設定
データバックアップ
ネットワークプロキシ設定
ホットキー
Apidogの更新
OpenAPIアクセストークンの生成
アカウント削除
参考資料
Swagger拡張機能
Socket通信:パケットの分断と結合
用語の説明
よくある質問
API-デザインファーストアプローチ
Apidog OpenAPI仕様拡張
JSONPath
XPath
正規表現
JSONスキーマ
CSVファイルフォーマット
Java環境のインストール
ランナーのデプロイ環境
ApidogフレーバーMarkdown
ベストプラクティス
API署名の取り扱い方法
多くのAPIでは署名検証が必要であり、通常のワークフローでは、まず手動で署名APIにアクセスし、取得した署名を他のリクエストに添付します。このプロセスは非常に煩雑です。
このフローを効率化するために、他のAPIにリクエストする際に最新の署名を自動的に取得する方法を提供します。
API署名の取り扱い方法
#
1.
署名ロジックを実装するパブリックスクリプトを作成し、APIリクエストパラメータを読み取り、組み込みライブラリ(例:crypto-js)を使用して署名を生成します。
2.
生成された署名をパラメータとして追加する方法は2つあります。
方法1: 署名パラメータを追加し、スクリプトを介して直接リクエスト情報を変更します(環境変数を使用する必要はありません)。
方法2: 生成された署名を環境変数に書き込み、APIパラメータでその変数を参照します。
3.
上記で作成したパブリックスクリプトをAPIの前処理スクリプトで参照します。
4.
署名アルゴリズムが他の言語で記述されている場合、
dog.execute
メソッドを使用して他の言語で記述されたプログラムを呼び出すことができます。
例
#
署名生成ルール
#
ステップ1: パラメータを集合Mとして設定します。集合M内の空でないパラメータをASCIIコードに基づいて昇順に並べ替え、URLキー値ペア形式(つまりkey1=value1&key2=value2...)を使用して空でないパラメータをstringAに連結します。
ヒント
1.
パラメータ名をASCIIコードに基づいて昇順(辞書順)に並べ替えます。
2.
空のパラメータ値は署名に含まれません。
3.
パラメータ名は大文字と小文字を区別します。
4.
signパラメータも署名に含まれません。
ステップ2: stringAの末尾にキーを連結してstringSignTempを取得し、stringSignTempにMD5アルゴリズムを使用し、結果の文字列を大文字に変換してsignValueを取得します。
パブリックスクリプトの実装
#
翻訳API署名の例
#
署名生成ルール
#
ステップ1: appid、翻訳対象のテキストq(UTF-8エンコーディング)、ランダムな数値salt、およびプラットフォームが割り当てたキー(管理コンソールで利用可能)をappid + q + salt + keyの順序で連結してstring 1を作成します。
ステップ2: string 1にmd5アルゴリズムを使用して32ビットの小文字の署名を取得します。
ヒント
1.
翻訳対象のテキスト(q)はUTF-8エンコーディングである必要があります。
2.
appid+q+salt+keyを署名に連結する際、qにURLエンコードを適用しないでください。署名が生成された後、HTTPリクエストを送信する前にqにURLエンコードを適用します。
パブリックスクリプトの実装
#
Modified at
3 months ago
Previous
Apidog コラボレーションワークフロー
Next
Apidogでの認証状態の管理
On this page
API署名の取り扱い方法
例
署名生成ルール
パブリックスクリプトの実装
翻訳API署名の例
署名生成ルール
パブリックスクリプトの実装