Custom endpoint fields

When collaborating on APIs, there may be a need for some custom additional fields to describe endpoints. For example, you could add fields such as "Authorization Required," "Response Format," or "Rate Limiting Policy" to provide more context to users consuming the API.

In Apidog, you can leverage Customized Fields to implement these additional fields seamlessly.

Configure custome fields

You can set up endpoint fields in Apidog by navigating to Settings > General Settings > Feature Settings > Endpoint Feature Settings. The customized fields that you configure here will apply project-wide in Apidog.

Apidog provides three default built-in fields that you can manually enable or disable. If enabled, the field will appear in the endpoint metadata.

Add new field

You also have the flexibility to add your custom fields as needed.

The field type in Apidog supports the following types: Text, Number, Single select, Multiple select, Date, Team member, Link, Email, Single label, and Multiple label.

Show fields in API documentation

In Quick Share, you have the option to choose whether to display these custom fields.

When creating a Quick Share in Apidog, you can select the option "Show API Fields" to include the API fields you defined.

Select fields to be displayed.

They will be displayed in the documentation.

When publishing documentation in Apidog, you can also choose which fields to display. In the Share Docs section, under Publish Docs > Basic Settings > Content Display, you have the option to select fields.

Custom endpoint fields

Configure custome fields#

Add new field#

Show fields in API documentation#

Configure custome fields

Add new field

Show fields in API documentation