api-debugging Locale JP

APIdogでAPIリクエストのボディにパラメータを一括追加する方法は？

shimizu chioka

Updated on 2024年11月1日 4分読む

ApidogでAPIを設計する際、多数のリクエストパラメータを追加する必要がある状況に直面することがあります。数十個または数百個のパラメータを必要とするエンドポイントを想像してみてください。「編集」セクションで各パラメータを個別に追加するのは面倒で、時間がかかり、エラーが発生しやすくなります。

幸いなことに、Apidogではパラメータをバッチで追加する方法を提供しており、プロセスをスムーズかつ効率的にすることができます。

この記事では、リクエストパラメータを一括追加するためのさまざまな方法を探ります。それでは詳細に入っていきましょう。

ボタン

方法1：バルク編集機能の使用

ボディパラメータタイプがform-dataまたはx-www-form-urlencodedの場合、「バルク編集」機能を利用してリクエストパラメータを追加できます。

バルク編集機能にアクセス：

パラメータリストで、右上隅にある「バルク編集」ボタンを見つけます。このボタンをクリックすると、パラメータを一括で入力できるテキスト編集ボックスが開きます。

CSV形式でパラメータを入力：

パラメータはCSV形式である必要があります。たとえば、form-dataパラメータの場合、必要な形式は次のとおりです：

パラメータ名, タイプ, 必須, 例の値, コンテンツタイプ, 説明

コンマで区切られた各項目は、必要に応じて空白のままにできます。AIツールを利用してこのデータを整理し、エラーを最小限に抑えることができます。以下は一例です：

email, string, false, user@gmail.com, text/plain, ユーザーのメールアドレス
password, string, false, ********, text/plain, ユーザーのパスワード

パラメータを入力した後、「OK」ボタンをクリックして対応するリクエストパラメータを生成します。

方法2：既存のフォーマットからパラメータを生成

JSONやXMLなどのボディパラメータタイプを使用している場合、特定のフォーマットに直接内容を貼り付けて、パラメータを自動的に生成できます。

JSONを使用してパラメータをバルク追加：

パラメータリストで「JSONから生成」ボタンをクリックすると、JSONオブジェクトを貼り付けたり入力したりするためのテキスト編集ボックスが開きます。

JSON内のコメントは、パラメータの説明として認識されます。オーバーライドモードや命名規則を必要に応じて指定できます。以下は一例です：

{"region_id": "82","email": "b.wawjn@gmail.com", // ユーザーのメール"sales_channel_id": "12","customer_id": "98","country_code": "70", // 国コード"context": {"ip": "::1","user_agent": "Chrome"
    },// その他のパラメータ...
}

確認する前に、入力したJSONデータをプレビューできます。

編集が完了したら、「OK」ボタンをクリックして対応するリクエストパラメータを生成します。

「自動生成」スイッチがオンになっている場合、リクエスト例も生成されます。

XMLを使用してパラメータをバルク追加：

JSONと同様に、XMLデータを編集ボックスに貼り付けることもできます。「OK」ボタンをクリックして、関連するリクエストパラメータを生成してください。以下は一例です：

データベースからのインポート：

必要なデータテーブルを選択して接続することによって、データベースからパラメータをインポートするオプションもあります。データベースのフィールドコメントは、説明や名前として使用できます。

また、SQL DDLステートメントを入力してパラメータを生成することもできます（現在はMySQLのみ対応）、次のように：

CREATE TABLE 
carts
 (
  id int NOT NULL AUTO_INCREMENT,
  region_id varchar(10) DEFAULT NULL,
  email varchar(255) DEFAULT NULL,
  sales_channel_id varchar(10) DEFAULT NULL,
  customer_id varchar(10) DEFAULT NULL,
  country_code varchar(10) DEFAULT NULL,PRIMARY KEY (
id
)
) ENGINE=InnoDB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;

方法3：共通のパラメータ/データモデルの追加

Apidogでは、よく使うパラメータテンプレートを作成して使用することができ、共通のパラメータやデータモデルを通じて、類似のAPI間で再利用が可能です。

共通のパラメータの追加：

左側のナビゲーションバーで「設定」を選択し、「共通のパラメータ」をクリックして、頻繁に使用するパラメータを追加します。

APIで共通のパラメータを使用する必要があるときは、パラメータ入力ボックスをクリックするだけで、事前定義されたパラメータをすばやく選択するためのパネルが表示されます。

スキーマの追加：

左側のナビゲーションバーの「スキーマ」オプションを見つけ、「新しいスキーマ」ボタンをクリックして、モデルの名前と説明を入力し、フィールドを追加して各フィールドのタイプ、例の値、説明を定義します。

スキーマパラメータは、方法2で説明したように、JSONまたはJSONスキーマを通じて生成することもできます。

リクエストやレスポンスでスキーマを使用する必要がある場合は、タイプ（例：オブジェクト）をクリックし、ポップアップリストから「他のスキーマを参照」を選択します。

リストから事前定義されたスキーマを選択すると、パラメータは自動的にAPIに入力されます。

いくつかのパラメータを追加または修正する必要がある場合は、対応する「データスキーマ」で修正するか、それらをデリファレンスできます。デリファレンスすると、リクエストパラメータはもはや共通のデータモデルに依存せず、独立して存在し、現在のAPI専用になります。

方法4：cURLコマンドのインポート

ApidogはcURLコマンドの直接インポートをサポートしており、特にテスト目的でcURLコマンドを提供するサードパーティプラットフォームからのAPIのリクエストパラメータの迅速な設定が可能です。

cURLコマンドをインポートするには、提供されたコマンドをコピーし、新しいAPIのアドレスバーに貼り付けるだけです。ApidogはcURLコマンドを自動的に解析し、対応するリクエストパラメータを生成します。

プロジェクトの検索ボックスの隣にある「+」ボタンをクリックし、「cURLをインポート」を選択し、コピーしたコマンドをダイアログに貼り付けて「OK」をクリックすることもできます。

APIとして保存すると、JSONリクエストボディはAPIドキュメントに合わせて自動的に構造化されます。

結論

この記事では、Apidogでのリクエストパラメータを一括追加するためのさまざまな方法を紹介しました。CSVデータのバルク編集機能を使用したり、JSONやXML形式からパラメータを生成したり、データベースからインポートしたり、事前定義されたパラメータテンプレートを利用したり、cURLコマンドを直接インポートしたりすることができます。これらの多様なアプローチを利用して、ニーズに応じてAPIリクエストパラメータを効率的に管理できます。

ボタン