轻松完成word格式的接口文档
今天在开发完一个项目的接口之后,公司领导过来说:”需要一份word格式的接口文档,***本门主任需要看这些文档,记得接口文档做的好看一点“。然后领导拍拍我的肩膀转身就走了,身为一个资深后端,尤其是在外包公司,特别是给政府本门做外包的时候 。对于文档要求特别多,什么都需要文档说明。
我本人本身都不爱弄word这一块的接口文档,因为还要弄格式,每个接口参数、请求方式、响应都需要自己去一个一个粘贴,调格式特别麻烦。有时候一个项目功能负责点,接口特别多的时候。几百个接口需要弄两三天,比敲代码还累就很苦恼。就在想有没有工具弄够在我开发接口的时候,既能测试接口是否通顺,还能生成网页格式的接口文档或者我开发的时候前端也能在这个软件中看到我开发的接口,然后他通过这个工具测试接口是否开发完成。查看接口返回的数值。最重要是还能支持word格式的接口文档。
我先使用了postman,能支持生成接口文档,还能测试接口,但是英文版的看的比较费劲。还有就是不能生成样板格式完美的word版本的接口文档。
就在想国内有没有一款这样的软件,于是就在网上查找起来,发现有几个做接口测试的工具但是还是没有我需要的,要么就是和postman一样的,要么就是操作使用特别复杂的东西,体验感极差。
然后把需求发给自己经常活跃的技术活动交流群,有人告诉我有一个叫apipost的接口文档生成工具,可以生成word格式的接口测试文档。然后我就去下载试用了一下。
这个软件使用的时候需要注册有点烦,但是对于要写几百个接口文档的烦恼这个啥都不算了。
注册之后,需要生成一个项目才可以继续下去,我把我的项目编写了一下,然后开始了接口测试
全中文版的还不错,测试接口也很不错,然后去试试怎么生成接口文档的功能。
看了一下有一个分享的功能点进去操作一下
去复制链接,然后去网页中打开。
看着网页版的接口文档,感觉挺不错的,但是我想要的是word格式的接口文档啊!仔细观看了一下,有一个导出离线文档,打开一看。我需要的导出word格式在这啊。果断点击下载。看看效果,如图:
导出的word样式排版格式感觉就特别棒。不过这是单个接口的,去试试多个接口的,整个项目的接口生成word格式的接口文档。
我们还是需要分享项目,然后在网页上才能进行word格式的下载。
打开压缩包,发现生成的是单个文件,还需要自己合并
合并教程office和wpc都是一样的合并方式:
在插入中找到对象,选择对象中的文件中的文字,进行文件合并。
这就是apipost如何生成word格式的接口文档了。剩下的我们很大一笔写word格式的接口文档时间。
轻松完成word格式的接口文档相关推荐
- apipost生成word格式的接口文档,接口文档合并操作
一.Apipost导出单个接口word 1.Apipost在分享完网址链接之后,有一个导出离线文档的功能.有导出HTML.导出MarkDown和导出word格式. 2.选择导出word文档 下载的为压 ...
- 【技巧】ApiPost生成word格式的接口文档,接口文档合并操作
一.Apipost导出单个接口word 1.Apipost在分享完网址链接之后,有一个导出离线文档的功能.有导出HTML.导出MarkDown和导出word格式. 2.选择导出word文档 下载的为压 ...
- 根据mysql生成数据库设计文档_通过navicat工具导出数据库的word格式的设计文档...
1.打开数据库 1.1.打开数据库,执行如下查询语句,查询单个表的语句 SELECT COLUMN_NAME 代码, COLUMN_COMMENT 名称, COLUMN_TYPE 数据类型, 'fal ...
- java接口文档生成工具_接口文档生成
一.为什么要写接口文档? 1.正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 2.项目开发过程中前后端工程师有一个统一的文件进行沟通 ...
- java接口文档生成工具_【分享】接口文档生成工具apipost
一.为什么要写接口文档? 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发 ...
- 接口文档生成工具apipost
一.为什么要写接口文档? 正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 2.项目开发过程中前后端工程师有一个统一的文件进行沟通交流 ...
- 接口文档如何编写,接口文档快速生成工具
正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要.下面我总结下自己看到的优秀接口文档. 一.背景介绍 接口:API API(Applic ...
- 【DEVOPS】实现Swagger2应用接口文档Word格式的在线实时更新
借助 maven plugin + 自定义服务Swagger2Word服务,实现满足自定义格式需求的RESTful API文档的实时更新和在线展示.(注意:这里的API接口文档是独立于应用的,不似Sw ...
- swagger-ui导出word接口文档
开发时用的swagger-ui API接口开发,项目交付时客户需要word形式的接口文档,几百个接口,不可能一个一个写噻,直接通过下面的微springboot项目生成word文档快捷方便 代码分享链接 ...
最新文章
- python函数分几种_简单了解Python中的几种函数
- 什么是springboot框架
- 线程池是如何复用的?
- 树莓派声音输出设置_树莓派声音设置
- 如何检测 SAP 电商云 Spartacus UI 当前正处于导航状态
- SWAT 学习相关基础知识(一)---Mr.Zhang
- 121. Best Time to Buy and Sell Stock 题解
- MySQL对浮点数设置保留位数
- hiho一下第91周《Events Arrangement》(前半部分)
- 专科学历去学计算机,前景到底如何?
- mysql 综合练习
- 秒杀工具 吃鲸秒杀
- coco2d-x学习第一章 codo2d-x 2.2.3+vs2010环境搭建和新建项目
- laravel 分页样式
- 关于OPC的一些组件、没有注册类
- 图纸识别自动生成BOM清单的方法
- 俄罗斯方块shell脚本
- 浅析组合子集和的互异性
- HDMI差分对走线是否需要走等长
- 原型工具介绍———墨刀以及Axure RP比较
热门文章
- CCCF精选 | 李德毅:机器如何像人一样认知——机器的生命观
- 空指针异常可能出现的原因
- 台式机切换有线/无线网脚本
- Textual Entailment(自然语言推理-文本蕴含) - AllenNLP
- python添加win32com包,将ppt转换为图片
- Vue组件通信(父传子、子传父、兄弟通信)
- 商业智能下,金融行业如何利用起来?
- Word文档使用Mathtype如何实现公式自动居中并右对齐编号?
- 自学python能不能找到工作,学会了python好找工作吗
- 击败26个硕士,本科生“歪门邪道”月薪过万