メインコンテンツまでスキップ

カスタムフィールド

カスタムフィールド機能を使用すると、プロジェクトの管理者は、自分のニーズに応じてAPIドキュメントの共通フィールド(作成時間、TAPDのリンク、要件定義書のリンクなど)を設定できます。この機能のおかげで、プロジェクトの管理がさらに便利になります。

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

プロジェクト設定機能設定の下にあるAPI 機能設定セクションで、管理者はプロジェクトの需要に応じてカスタムフィールドを設定できます。

apidog

  1. フィールド名:フィールドの名前

  2. フィールドタイプ:テキスト、数字、単一選択、複数選択、日付、プロジェクトメンバー、リンク、メールアドレス、単一選択タグ、複数選択タグをサポートします。

  3. ツールチップ:プロジェクトメンバーに表示され、コンテンツを入力するときに提示メッセージが表示されます。

  4. 対応するOpenAPIフィールド: OpenAPI/Swagger 形式のデータをインポート/エクスポートするときに使用します。空白のままにすると、OpenAPI/Swagger 形式のデータをインポート/エクスポートするときにフィールドを無視します。

  5. ON:管理者は、必要に応じてカスタムフィールドを有効/無効にすることができます。

apidog

カスタムフィールドを記入

カスタムフィールドを設定して有効にすると、APIの変更ページで当該フィールドが表示されます。

apidog

カスタムフィールドを表示

カスタムフィールドを設定して有効にすると、対応する情報がAPIページに表示されます。

apidog