共通パラメーター

API 仕様書を編集する際、開発者はリクエストパラメーターやレスポンスフィールドに対して、同じパラメーター名、説明、その他の情報を繰り返し入力する必要があります。

このデータを毎回手動で再入力するのは非効率的で、エラーが発生しやすくなります。このプロセスを簡素化するために、Apidog は「共通パラメーター」機能を提供しており、事前に定義された値を素早く入力できます。

共通パラメーターの活用

右側メニューの「説明」ボタンをクリックすると、作成した共通パラメーターが一覧表示されます。

「パラメーター名」入力フィールドをクリックすると、事前に設定された共通パラメーターのリストが自動的に展開されます。このリストから任意のパラメーターを選択すると、対応するパラメーター名、説明、その他の関連情報が自動的に入力されます。

共通パラメーターの設定

事前に定義された共通パラメーターを変更したい場合は、API 仕様書内の「説明」メニューボタンをクリックして、共通パラメーター設定にアクセスします。

パラメーター名、説明、およびその他の詳細を入力し、「保存」ボタンをクリックします。

共通パラメーターが設定されると、API 仕様書作成時に「パラメーター名」入力フィールドをクリックすると、ドロップダウンメニューに表示されます。リストからパラメーターを選択すると、その対応する詳細情報が自動的に入力されます。

または、「設定」-「共通パラメーター」で管理することもできます。