APIのカスタムフィールド

APIの共同開発では、APIをより詳しく説明するためにカスタムフィールドが必要になることがある。例えば、「認証必須」「レスポンス形式」「レート制限ポリシー」といったフィールドを追加して、API利用者により多くの情報を提供できる。

Apidogでは、カスタマイズフィールドを使ってこれらの追加フィールドをシームレスに実装できる。

カスタムフィールドの設定

Apidogでは、「設定」 > 「一般設定」 > 「機能設定」 > 「API機能設定」からAPIフィールドを設定できる。ここで設定したカスタムフィールドは、プロジェクト全体に適用される。

Apidogには3つのデフォルトの組み込みフィールドがあり、手動で有効・無効を切り替えられる。有効にすると、そのフィールドはAPIのメタデータに表示される。

必要に応じて、カスタムフィールドを自由に追加できる。

Apidogのフィールドタイプは以下をサポートしている：テキスト、数値、単一選択、複数選択、日付、チームメンバー、リンク、メール、単一ラベル、複数ラベル

クイックシェアでは、これらのカスタムフィールドを表示するかどうかを選択できる。

Apidogでクイックシェアを作成する際、「APIフィールドを表示」オプションを選択して定義したフィールドを含められる

表示するフィールドを選択する

ドキュメントに表示される

Apidogでドキュメントを公開する際も、表示するフィールドを選択できる。ドキュメント共有セクションの「共有」 > 「基本設定」 > 「コンテンツの公開」で、フィールドを選択するオプションがある。