API Attributes

提示

To accommodate unique usage scenarios that conventional documentation standards may not fully address, some teams need to add custom attributes to their documentation.

EchoAPI offers support for custom extended interface attribute fields, allowing enterprises to define and include additional field types in their interface documentation as needed.

How to Use

To customize and add attribute fields, go to Project Settings -> API Attributes. Currently, the supported field types include text, number, single choice, multiple choice, date, link, and email.

Presentation in Interface Documentation

Custom-added interface attributes are not displayed in the documentation by default. You need to select which fields to include when sharing the documentation, and only the selected fields will be visible.