常用フィールド

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

常用フィールドの設定

常用フィールドを変更または設定するには、以下の手順に従う：

フィールド設定にアクセス

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

または、[設定] - [プロジェクトリソース] - [常用フィールド] で常用フィールドを管理することもできます。

詳細を入力

フィールド名、説明、その他必要な情報を入力する

フィールドを保存

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

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

APIでフィールド名を入力する際、事前に定義された常用フィールドが選択肢として表示される。常用フィールドを選択すると、その説明が自動的に入力される。