5 分钟打造好用难看 API 文档
🤔️ 你是否遇到过这样的场景？
- 对接第三方开放平台文档的时候，左手刷着接口文档看 API，右手操作着接口调试工具 🧱
- 写完接口想交付或提供 API 文档给第三方应用，又感觉文档展现体验个别？很鸡肋？
前言
晚期第三方开放平台的凋谢接口文档，次要以信息展现为主，根本信息包含申请形式、参数阐明、返回后果等等。这里以企业微信开发者核心文档为例 👇
而在很长一段时间，为了调试凋谢接口，咱们是不是也是常常习惯右边对着接口文档，左边关上 Postman 调试。
而在上周微信开放平台上线了 调试工具 ，将 文档与在线调试 一体化交融。从某种意义上突破了原有繁多的 信息展现 为主的场面
而这样带来的益处就是通过接口文档即可一键到达调试工具台
🤔️ 那如果其余的开放平台都 反对在线调试，是不是效率就晋升了一个 level？
通过上文咱们看到微信实际上提供了一个调试工具赋能原有的接口文档
然而其余平台，如果想省时省力也开发一套 具备在线调试的接口文档体系
那 Apifox 会是你最称心的抉择
官网地址：apifox.cn
Apifox 在接口文档中集成了 调试性能 、 代码在线生成 等等 👇
上图是接口治理 Saas 服务商 Apifox 推出的Apihub（凋谢 API 共享平台）其中企业微信的凋谢文档。
通过文档在线调试，进一步晋升开发者对接开放平台 API 的效率。
该平台目前曾经聚合了 大部分支流第三方凋谢 API
换句话说通过 Apifox 赋能 的凋谢 API 文档 都是具备在线调试、代码生成。包含一下特色
反对在线调试：点击申请，实时显示调试后果，返回信息高深莫测
主动生成代码片段：反对主动生成代码片段，省时省力更高效
🤔️ 那作为集体凋谢者，是否能够通过 Apifox 公布这样难看好用的 API 文档？
能够的，5 分钟教你搞定！
Apifox 公布 API 文档
首先咱们在 Apifox 软件的在线分享 Tab 中找到 新建分享 按钮
而后在新建分享的弹窗中抉择分享属性（文档语言、拜访明码、环境抉择、分享范畴等等）这里以宠物商店 Demo 为例
保留胜利后将鼠标挪动到分享列表中的刚刚创立的分享中，点击界面中呈现的关上链接 👇
关上 Apifox 生成接口文档出现如下，同样也能够反对在线调试！
🤔️ 那能够在生成的接口文档在进一步自定义“装璜”下不？
能够的，Apifox 目前提供的文档自定义的区域有
顶部导航菜单顶部导航右侧功能区文档内容底部 Banner 区
能够在公布文档栏目下进行定义
后续在官网文档也有提及，将会有更多凋谢区域供咱们 DIY！
不仅如此，你还能够自定义域名。目前通过 Apifox 公布的文档应用 xxx.apifox.cn 格局的 URL，然而你能够将你的域名间接指向你公布的文档 👇
- 1. 在
公布文档 > 公布设置面板中设置本人自定义的域名
- 2. 增加 Apifox 的
CNAME到你域名厂商的配置核心
最初公布通过你自定义的接口文档，也能够申请公布到上文提到的 API Hub 中
实现上述操作，你将会播种一个好用难看 API 文档
- API 文档是反对在线调试的
- 域名是你自定义的
- 文档自定义区域是你 DIY 的
分享给敌人倍有体面！
官网地址：apifox.cn
最初
API 文档性能只是 Apifox 弱小性能中冰上一角，还提供了 API 调试、API Mock、API 自动化测试 等性能