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生成接口文档呈现如下,同样也可以支持在线调试!

编辑切换为居中

添加图片注释,不超过 140 字(可选)

️ 那可以在生成的接口文档在进一步自定义“装饰”下不?

​可以的,Apifox 目前提供的文档自定义的区域有

  • 顶部导航菜单

  • 顶部导航右侧功能区

  • 文档内容底部Banner区

可以在发布文档栏目下进行定义

后续在官网文档也有提及,将会有更多开放区域供我们DIY!

不仅如此,你还可以自定义域名。目前通过Apifox发布的文档使用 xxx.apifox.cn 格式的URL,但是你可以将你的域名直接指向你发布的文档

  • 1.在发布文档 > 发布设置 面板中设置自己自定义的域名

  • 2.添加Apifox的CNAME到你域名厂商的配置中心

​最后发布通过你自定义的接口文档,也可以申请发布到上文提到的API Hub中

完成上述操作,你将会收获一个好用好看API文档

  • API文档是支持在线调试的

  • 域名是你自定义的

  • 文档自定义区域是你DIY的

分享给朋友倍有面子!

最后

API文档功能只是Apifox强大功能中冰上一角,还提供了API调试、API Mock、API自动化测试等功能

官网地址:apifox.cn

编辑切换为居中

添加图片注释,不超过 140 字(可选)

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
### 回答1: ArcGIS API for JavaScript 3.9是一种基于JavaScript的Web开发工具,可以使用它来构建交互性和可视化性很强的GIS应用程序。API提供了丰富的地图显示和交互功能,使得用户可以轻松地在地图上进行搜索、浏览、编辑和分析等操作。 该API还提供了许多基本和高级工具,包括底图选择、图例、搜索、还原操作、渲染和动画等。它还支持多种类型的数据,包括栅格、矢量等,并支持与其他ArcGIS平台数据的兼容性。 此外,API还提供了强大的开发工具,包括开发者文档、代码示例和应用程序模板等,这些工具可帮助开发人员更快速地构建应用程序并提高生产力。开发者可以通过使用API打造卓越的GIS应用程序,实现更好的数据可视化、数据分析和空间查询等功能。 ### 回答2: ArcGIS API for JavaScript 3.9(以下简称JS API)是一个基于浏览器的GIS编程接口,它可以让Web 开发者快速构建地理信息应用程序。该文档提供了详细的使用说明和API参考文档,以帮助开发者快速上手。JS API 3.9 支持与ArcGIS Server、ArcGIS Online和Portal for ArcGIS等平台进行交互,支持多种数据源,如:Web Map Service (WMS)、Web Feature Service (WFS)、GeoRSS、CSV、KML等,用户可以通过地图、图层、标注和样式等多种方式来创建交互式的地图应用程序。同时,JS API 3.9 还提供了大量的工具和插件,包括编辑器、查询工具、测量工具等,可以快速搭建自己所需的应用程序。 总之,JS API 3.9 具备了很好的开发性能和易于使用性,可以迅速构建出高质量的地理信息应用程序,有助于用户更好地进行空间分析和地理数据可视化等操作。 ### 回答3: ArcGIS API for JavaScript 3.9是一个基于JavaScript的开发工具包,用于构建Web地图应用程序和跨平台GIS应用程序。它提供了一组丰富的开发API和工具,能够访问和处理地理空间数据。API支持基本地理空间操作,如添加图层、缩放和平移地图视图,以及高级操作,如地理空间分析、三维可视化和协同编辑等。随着API的不断发展,它还支持移动设备和桌面应用程序开发,并提供跨平台的开发解决方案,满足不同开发需求。 ArcGIS API for JavaScript 3.9提供了一份详细而全面的文档,包含了所有API以及相关示例,能够帮助开发人员更轻松地学习和使用API。同时,该文档也提供了许多实践案例,涵盖了不同的应用场景和解决方案,帮助开发人员快速了解API的用法,并应用到实际项目中去。文档中还包含了详细的API文档和代码示例,这些示例不仅展示了如何使用API来解决实际问题,还详细介绍了API的各种使用方法和特性。对于开发人员来说,这是一个非常有用的参考资料,可以帮助他们快速了解和使用API。 总之,ArcGIS API for JavaScript 3.9是一个功能强大的GIS开发工具包,它提供了丰富的API和工具,能够访问和处理地理空间数据,满足不同的开发需求。而文档则提供了详细的API和示例,帮助开发人员更加轻松地学习和使用API,是一个非常有价值的参考资料。

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值