共通パラメータ

API開発では、API間での一貫性を維持することが重要だ。Apidogは 共通パラメータ 機能を提供し、異なるAPI間で同じ名前と説明を持つパラメータを再利用できるようにしている。

共通パラメータの設定

共通パラメータを変更または設定するには、以下の手順に従う：

パラメータ設定にアクセス

API仕様インターフェース内の説明セクションにあるメニューボタンをクリックする

または、[設定] - [プロジェクトリソース] - [共通パラメータ] で共通パラメータを管理することもできます。

詳細を入力

パラメータ名、説明、その他必要な情報を入力する

パラメータを保存

「保存」ボタンをクリックして入力内容を確定する

カンマまたはコロンを区切り文字として使用し、よく使用されるパラメータのインポートまたは一括編集をサポートしている。

APIでパラメータ名を入力する際、事前に定義された共通パラメータが選択肢として表示される。共通パラメータを選択すると、その説明が自動的に入力される。