共享 API 文档

一旦你的 API 开发完成并成功调试，Apidog 可以轻松生成专业文档，供你与团队、利益相关者或外部开发者共享。

分步指南

按照以下步骤生成并共享你的 API 文档：

步骤 1：访问 Share Docs 模块

1. 打开你的 Apidog 项目

2. 从侧边栏切换到 Share Docs 模块

步骤 2：创建新的共享

1. 点击 New 按钮以创建新的文档共享
2. 这将打开共享配置对话框

步骤 3：配置共享设置

在共享配置中完成以下设置：

设置	描述	建议操作
Name	为你的共享提供一个描述性名称	使用项目名称 + 版本（例如，“Pet Store API v1.2”）
Environments	选择要包含的环境	选择所有环境，以生成完整的文档
Access	设置可见性权限	根据你的受众选择合适的访问级别


3. 点击 Save 创建你的共享

步骤 4：访问你的文档

1. 你的新共享将显示在共享列表中
2. 点击 Open 在 Web 浏览器中查看你的文档
3. 文档将在新标签页中打开，并带有可共享的 URL

步骤 5：探索文档功能

你的文档包含强大的功能：

• 交互式 API 浏览器：在左侧目录树中浏览端点

• Try It Out：直接从文档发送实时请求

• 代码生成：生成请求代码片段和数据模型代码

• 环境切换：测试不同的 API 环境

高级自定义与发布

Apidog 为你的文档提供了更多自定义选项：

功能	描述	使用场景
自定义布局	修改文档结构和外观	品牌一致性、用户体验优化
自定义域名	使用你自己的域名	专业展示、品牌识别
自定义 URL	创建易记且有意义的 URL	营销、便捷共享、SEO 优势
访问控制	设置精细化权限	内部团队、外部合作伙伴、公开访问

---

了解更多关于在 Apidog 中设计、测试、模拟和发布 API 的内容。