概述 - Apidog Docs

Apidog 提供强大的发布能力，可将你的 API 规范转换为专业的交互式文档。无论你需要在团队内部共享 API，还是公开发布全面的文档，Apidog 都提供灵活的选项来满足你的需求——从快速共享链接到使用你自己的域名完全自定义的文档站点。

共享你的 API 文档

Apidog 提供多种共享和发布 API 文档的方式，每种方式都针对不同的使用场景而设计：

快速共享：基于你定义的 API 规范，一键生成美观的 API 文档，非常适合快速协作

交互式文档：启用“Try it out”功能和在线代码生成，便于动手探索 API

文档站点：发布全面的文档站点，将 Markdown 内容与 API 文档结合起来，形成完整的用户指南

自定义导航：自定义文档的导航栏，以改善用户体验

自定义域名：将文档绑定到你自己的域名，用于专业品牌展示

自定义 URL：定义自定义页面 URL 结构

文件夹自定义：在文档中自定义文件夹样式和点击行为

多版本发布：同时发布和管理多个 API 版本

示例文档

查看已发布文档的真实示例：https://docs.salla.dev/

Apidog 为几乎任何 API 技术的文档编写提供全面支持。无论你使用的是传统 REST API、现代 GraphQL、实时 WebSocket 连接，还是企业级 SOAP 服务，Apidog 都能满足你的需求。

支持的技术包括：REST、SOAP、GraphQL、gRPC、WebSocket、SSE 等。

浏览我们的文档最佳实践和真实 API 示例集合，了解如何有效地为不同类型的 API 编写文档。

了解更多

在支持的 API 技术中查看每种 API 技术的详细指南和示例。

Apidog 提供两种不同的发布方式，每种方式都针对不同场景进行了优化。了解它们之间的差异将帮助你根据需求选择合适的方法。

快速共享 专为快速、灵活的协作而设计——非常适合在开发过程中与团队成员或外部合作伙伴共享特定 API。发布文档 则用于创建专业的、面向公众的文档站点，并具备完整的自定义能力。

建议

将 快速共享 用于内部协作和快速 API 评审。当你需要面向公众的专业品牌化文档站点时，请使用 发布文档。