自定义协议 API

自定义协议 API 用于管理使用自定义协议的 API。

借助此功能，你可以以统一的方式创建和维护不同类型协议（如 Thrift、UDP、Kafka、RabbitMQ、RocketMQ 等）的 API 文档，并在 Apidog 中集中管理。

与 HTTP API 文档一样，自定义协议 API 文档也支持文件夹树、搜索和筛选选项、批量管理以及在线分享，从而让团队协作和对外分享更加便捷。

创建自定义协议 API

在文件夹树上方，将鼠标悬停在 + 图标上，然后选择 新建其他协议 API，并点击 其他自定义协议 API。

选择协议类型（选项包括 Thrift、Kafka 等，或点击 管理协议 添加自定义协议）。

每种协议都有默认模板可用。

填写以下详细信息：

URI：端点的唯一 ID，用于将其与其他端点区分开来（类似于 HTTP 端点的 URL 路径）。

端点名称：端点的名称。

基本信息：状态、维护者、标签和其他详细信息。

文档详情：允许更灵活地编辑描述、使用说明、示例等内容。

保存后，你将看到已创建的所选协议的端点文档。

自定义协议 API 文档也支持在线分享，让协作和对外展示更加便捷。

你可以复制协作链接，在项目内分享。

你也可以前往 发布文档 > 快速分享，选择要包含的端点，并选择是否分享自定义协议 API 文档。