[分享] 轻松快捷完成领导要求的word格式的接口文档,再也不用因为编写word格式的接口文档而烦恼

码农天地 -
[分享] 轻松快捷完成领导要求的word格式的接口文档,再也不用因为编写word格式的接口文档而烦恼

今天在开发完一个项目的接口之后,公司领导过来说:”需要一份word格式的接口文档,*本门主任需要看这些文档,记得接口文档做的好看一点“。然后领导拍拍我的肩膀转身就走了,身为一个资深后端,尤其是在外包公司,特别是给政府本门做外包的时候 。对于文档要求特别多,什么都需要文档说明。

我本人本身都不爱弄word这一块的接口文档,因为还要弄格式,每个接口参数、请求方式、响应都需要自己去一个一个粘贴,调格式特别麻烦。有时候一个项目功能负责点,接口特别多的时候。几百个接口需要弄两三天,比敲代码还累就很苦恼。就在想有没有工具弄够在我开发接口的时候,既能测试接口是否通顺,还能生成网页格式的接口文档或者我开发的时候前端也能在这个软件中看到我开发的接口,然后他通过这个工具测试接口是否开发完成。查看接口返回的数值。最重要是还能支持word格式的接口文档。

我先使用了postman,能支持生成接口文档,还能测试接口,但是英文版的看的比较费劲。还有就是不能生成样板格式完美的word版本的接口文档。

就在想国内有没有一款这样的软件,于是就在网上查找起来,发现有几个做接口测试的工具但是还是没有我需要的,要么就是和postman一样的,要么就是操作使用特别复杂的东西,体验感极差。

然后把需求发给自己经常活跃的技术活动交流群,有人告诉我有一个叫apipost的接口文档生成工具,可以生成word格式的接口测试文档。然后我就去下载试用了一下。

这个软件使用的时候需要注册有点烦,但是对于要写几百个接口文档的烦恼这个啥都不算了。

注册之后,需要生成一个项目才可以继续下去,我把我的项目编写了一下,然后开始了接口测试


全中文版的还不错,测试接口也很不错,然后去试试怎么生成接口文档的功能。

看了一下有一个分享的功能点进去操作一下

去复制链接,然后去网页中打开。

看着网页版的接口文档,感觉挺不错的,但是我想要的是word格式的接口文档啊!仔细观看了一下,有一个导出离线文档,打开一看。我需要的导出word格式在这啊。果断点击下载。看看效果,如图:


导出的word样式排版格式感觉就特别棒。不过这是单个接口的,去试试多个接口的,整个项目的接口生成word格式的接口文档。

我们还是需要分享项目,然后在网页上才能进行word格式的下载。


打开压缩包,发现生成的是单个文件,还需要自己合并

合并教程office和wpc都是一样的合并方式:

在插入中找到对象,选择对象中的文件中的文字,进行文件合并。



这就是apipost如何生成word格式的接口文档了。剩下的我们很大一笔写word格式的接口文档时间。

特别申明:本文内容来源网络,版权归原作者所有,如有侵权请立即与我们联系(cy198701067573@163.com),我们将及时处理。

php介绍

PHP即“超文本预处理器”,是一种通用开源脚本语言。PHP是在服务器端执行的脚本语言,与C语言类似,是常用的网站编程语言。PHP独特的语法混合了C、Java、Perl以及 PHP 自创的语法。利于学习,使用广泛,主要适用于Web开发领域。
上一篇: 开篇辟地

Tags 标签

前端php数据库

扩展阅读

加个好友,技术交流

1628738909466805.jpg