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

API属性

tip

従来のドキュメント標準では対応できない独自のユースケースに対応するため、一部のチームはドキュメントにカスタム属性を追加する必要があります。

EchoAPIは、企業が必要に応じてAPIドキュメントに追加のフィールドタイプを定義および含めることを可能にするカスタム拡張インターフェース属性フィールドのサポートを提供します。

使用方法

属性フィールドをカスタマイズして追加するには、プロジェクト設定に移動します。現在、サポートされているフィールドタイプには、テキスト、数値、単一選択、複数選択、日付、リンク、メールが含まれます。

image.png

image.png

image.png

image.png

APIドキュメントでの表示

デフォルトでは、カスタム属性フィールドはドキュメントに表示されません。ドキュメントを共有する際、表示させたいフィールドを選択する必要があります。

image.png

image.png