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.

Configuring Custom 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.

Adding New Fields

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

Supported field types:

Text

Number

Single select

Multiple select

Date

Team member

Link

Single label

Multiple label

Showing 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 Publish Docs section, under Publish Docs Sites > Customize > Appearance & Display Content, you have the option to select fields.

Custom Endpoint Fields

Configuring Custom Fields#

Adding New Fields#

Showing Fields in API Documentation#

Configuring Custom Fields

Adding New Fields

Showing Fields in API Documentation