乐趣区

关于前端:分享-轻松快捷完成领导要求的word格式的接口文档再也不用因为编写word格式的接口文档而烦恼

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

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

我先应用了 postman,能反对生成接口文档,还能测试接口,然而英文版的看的比拟吃力。还有就是不能生成样板格局完满的 word 版本的接口文档。

就在想国内有没有一款这样的软件,于是就在网上查找起来,发现有几个做接口测试的工具然而还是没有我须要的,要么就是和 postman 一样的,要么就是操作应用特地简单的货色,体验感极差。

而后把需要发给本人常常沉闷的技术流动交换群,有人通知我有一个叫 apipost 的接口文档生成工具,能够生成 word 格局的接口测试文档。而后我就去下载试用了一下。

这个软件应用的时候须要注册有点烦,然而对于要写几百个接口文档的懊恼这个啥都不算了。

注册之后,须要生成一个我的项目才能够继续下去,我把我的我的项目编写了一下,而后开始了接口测试


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

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

去复制链接,而后去网页中关上。

看着网页版的接口文档,感觉挺不错的,然而我想要的是 word 格局的接口文档啊!仔细观看了一下,有一个导出离线文档,关上一看。我须要的导出 word 格局在这啊。果决点击下载。看看成果,如图:


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

咱们还是须要分享我的项目,而后在网页上能力进行 word 格局的下载。


关上压缩包,发现生成的是单个文件,还须要本人合并

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

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



这就是 apipost 如何生成 word 格局的接口文档了。剩下的咱们很大一笔写 word 格局的接口文档工夫。

退出移动版