Endpoint Status

In Apidog, a useful built-in field is the Endpoint Status. This field is designed to indicate the status of an endpoint, whether it is in development, testing, or already released.

The Endpoint Status field is visible both in the Apidog app for internal team reference and in the API documentation generated by Apidog for external users.

Utilizing Endpoint Status

When specifying an endpoint in Apidog, you have the option to select the status of the endpoint. By default, a newly created endpoint is set to Developing.

In the endpoint specification, each status name is prefixed with a colored dot to signify the different statuses of endpoints. This color-coded system allows users to quickly distinguish between endpoints and their respective statuses in the endpoint directory tree.

Color Scheme

Color	Status	Description
Blue	Developing	Endpoint is currently in development
Red	Testing	Endpoint is being tested
Gray	Deprecated	Endpoint is deprecated
No dot	Released	Endpoint is released and does not require special attention

In the published documentation, you will also see these colored dots used to mark the status of endpoints.

Configuring Endpoint Status

Every team may have a different development process, and the required endpoint statuses can vary accordingly. Apidog allows teams to customize and choose which endpoint statuses to use based on their specific requirements.

You can configure and enable the desired endpoint statuses in Settings > General Settings > Feature Settings > Endpoint Feature Settings.

FAQ

Q: Can I customize a new status?

A: As different statuses correspond to specific functionalities, customizing a new status is not supported. You can choose from the listed statuses that best suit your team's needs.

Utilizing Endpoint Status#

Color Scheme#

Configuring Endpoint Status#

FAQ#

Utilizing Endpoint Status

Color Scheme

Configuring Endpoint Status

FAQ