5分钟打造好用好看API文档

上一篇 / 下一篇  2022-09-27 17:13:40

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 MockAPI自动化测试等功能

编辑

TAG:

 

评分:0

我来说两句

日历

« 2022-12-04  
    123
45678910
11121314151617
18192021222324
25262728293031

数据统计

  • 访问量: 12663
  • 日志数: 69
  • 建立时间: 2021-12-23
  • 更新时间: 2022-11-24

RSS订阅

Open Toolbar