当前位置: 首页 > 后端技术 > PHP

[分享]轻松快速完成领导要求的word格式的接口文档,再也不用为写word格式的接口文档发愁了

时间:2023-03-29 20:44:31 PHP

今天开发完一个项目的接口,公司领导过来了并说:“我需要一份word格式的接口文件,*本部门的主管需要阅读这些文件,记得把接口文件弄得更好看。”然后领导拍了拍我的肩膀,转身就走,作为一个资深的后端,尤其是在外包公司,尤其是外包给政府的时候。对文档的要求很多,凡事都需要文档。我自己不太喜欢编辑word的界面文档,因为需要编辑格式。每个接口参数、请求方法、响应都需要自己一一粘贴。调整格式很麻烦。有时一个项目负责功能,尤其是当接口很多的时候。上百个接口得两三天,比敲代码还累,很苦恼。我就想有没有什么工具可以在我开发界面的时候测试界面是否流畅,还可以生成web格式的界面文档,或者我开发的时候前端也能看到我在这个开发的界面软件,然后他用这个工具来测试接口是否开发好了。查看接口返回值。最重要的是它还可以支持word格式的界面文档。我最开始用的是postman,可以支持生成接口文档和测试接口,但是英文版比较难读。另外,模板格式的界面文档也无法生成完美的word版。想知道国内有没有这样的软件,于是上网搜了一下,发现有好几个接口测试的工具,但是还是没有我需要的。要么跟postman一样,要么就是操作起来特别复杂的东西,体验极差。然后把需求发到我经常活跃的技术活动交流群。有人告诉我,有一个接口文档生成工具叫apipost,可以生成word格式的接口测试文档。然后我就去下载试用了一下。使用这个软件需要注册有点烦,但是接口文档要写上百个,完全不用担心。注册后,需要生成一个项目才能继续。我写了我的项目,然后开始接口测试。完整的中文版还不错,测试界面也很好,接下来试试如何生成界面文件。看了下,有个分享功能,点进去操作复制链接,然后去网页打开。看网页版的接口文档,感觉还不错,但是我要的是word格式的接口文档!仔细看了下,有个exportofflinedocument,打开看看。我需要导出的word格式在这里。果断点击下载。看一下效果,如图:导出的word风格的排版格式感觉很好。但是这个是单一界面,多界面试试,整个项目的界面生成一个word格式的界面文档。我们还是要把项目分享出来,然后在网页上以word格式下载。打开压缩包,发现生成的文件是单个文件,需要自己合并。office和wpc的合并教程是一样的:在insert中找到object,在object中选择文件中的文本,合并文件。apipost就是这样生成一个word格式的接口文档的。我们其他人花很多时间用word格式编写界面文档。