Custom Protocol API

Custom Protocol API is used to manage APIs with custom protocols.

With this feature, you can create and maintain API documentation for different types of protocols (such as Thrift, UDP, Kafka, RabbitMQ, RocketMQ, etc.) in a unified way, all managed centrally within Apidog.

Just like HTTP API documentation, custom protocol API docs also support a folder tree, search and filter options, bulk management, and online sharing — making it easier for teams to collaborate and share externally.

Creating Custom Protocol API

Above the folder tree, hover over the+icon, then selectNew Other Protocol APIsand clickOther Custom Protocol API.

Select a protocol type(options include Thrift, Kafka, etc., or clickManage Protocolto add a custom protocol).

There are default templates available for each protocol.

Fill in the following details:

URI: The unique ID for the endpoint, used to distinguish it from others (similar to a URL path for HTTP endpoints).

Endpoint Name: The name of the endpoint.

Basic Information: Status, Maintainers, tags, and other details.

Documentation Details: allowing editing descriptions, usage instructions, examples, and more flexibly.

After saving, you'll see the endpoint documentation for the selected protocol created.

Custom protocol API docs also support online sharing, making collaboration and external presentation easier.

You can copy a collaboration link to share within the project.

You can also go toPublish Docs→Quick Share, select which endpoints to include, and choose whether to share custom protocol API docs.

Creating Custom Protocol API#

Sharing Custom Protocol API Docs#

Creating Custom Protocol API

Sharing Custom Protocol API Docs