对于我们这些程序员和程序媛来讲,最头疼的莫过于写文档。

我们可都是正个八经的理工校草和理工女神,研究github、逛逛csdn、写hello world是才我们的拿手菜,写文档是文科生的事情好不啦?(手动吐哇吐)

今天,教大家一个妙招:利用ApiPost一键、快速生成接口文档!

妈妈再也不用担心自己女孩纸们没有时间过38节啦!

当女程序媛遇到问题,那就不是问题

ApiPost简介:

ApiPost是一个支持团队协作,并可直接生成文档的API调试、管理工具。它支持模拟POST、GET、PUT等常见请求,是后台接口开发者或前端、接口测试人员不可多得的工具 。

官网:https://www.apipost.cn/

如果你对ApiPost了解不多,可以戳这里:https://www.cnblogs.com/phpwechat/p/10487077.html

利用ApiPost一键、快速生成接口文档:

当然,你得先下载安装apipost谷歌拓展或者客户端(个人建议客户端)。

接下来介绍具体步骤。

1、我们先准备一段接口代码用来测试。如图:

一个简单的测试接口

这个代码仅仅用来demo没啥技术含量,就是接受POST过来的2个参数,然后返回一个json。

2、接下来,具体操作如下图(全程图片-一看就懂):

发送结果

参数描述填写

3、利用全局注释功能,快速创建常见字段的描述

添加全局注释

添加全局注释

添加全局注释

4、点击顶部的文档模式就可以查看文档了。也可以导出为离线文档。

查看接口文档

导出接口文档

嗯,好了。女神们,接口文档也生成了,赶紧丢给前端过节去吧!……(^ _ ^)

axis2生成客户端代码_利用ApiPost一键、快速生成接口文档!女猿也过38节!相关推荐

  1. wsdl2java生成客户端代码_利用wsdl2java工具生成webservice的客户端代码

    1.JDK环境 2.下载apache-cxf发布包:http://cxf.apache.org/download.html 目前最新版本为3.2.6, 解压后如下: 解压发布包,设置CXF_HOME, ...

  2. 开发日记-20190328 关键词 利用eolinker一键快速生成API接口文档

    今天感觉效率真的很低= =各个层面的,apk发布到现场发现出现了问题,所以一个下午都在忙着解决现场出现的问题,领导一直打电话询问进度,午觉也没有睡所以今天预计的很多计划都处于停滞状态,像昨天规划的今天 ...

  3. aixs1 生成java代码_通过axis1.4 来生成java客户端代码

    1.首先下载axis-1.4所有的jar包, 2.我是直接打开cmd,进入到该jar包的目录下, 3.直接运行命令(运行这个命令之前要确定java的环境变量都已配置好): java -Djava.ex ...

  4. vvv在线文档导出工具_使用ApiPost工具快速生成在线接口文档

    ApiPost是一个支持团队协作,并可直接生成文档的API调试.管理工具.它支持模拟POST.GET.PUT等常见请求,是后台接口开发者或前端.接口测试人员不可多得的工具 .使用者不仅可以利用apio ...

  5. python处理word或者pdf文件_利用python程序生成word和PDF文档的方法

    一.程序导出word文档的方法 将web/html内容导出为world文档,再java中有很多解决方案,比如使用Jacob.Apache POI.Java2Word.iText等各种方式,以及使用fr ...

  6. 开发接口文档_产品经理必懂的接口文档撰写方式

    做产品经理的难免会调研各式各样的第三方需求能力.以满足产品提供用户的市场价值,比如第三方登录.图像识别.风控算法,都有专注的服务厂商. 企业无需自己花时间和精力投入在具有较高技术壁垒或时间成本的需求上 ...

  7. 写java接口的文档工具_【java】适合写接口文档的工具,或者文本语法

    由于后端与前端使用ajax交互,后端写接口文档变得非常有必要.以前我习惯用word写接口文档,但是最近与同事合作编写后端,word并不适合使用svn工具做同步,因为svn.git等无法自动合并word ...

  8. python生成word 带目录_利用python程序生成word和PDF文档的方法

    一.程序导出word文档的方法 将web/html内容导出为world文档,再java中有很多解决方案,比如使用Jacob.Apache POI.Java2Word.iText等各种方式,以及使用fr ...

  9. oxygen 生成java对象_利用oxygen编辑并生成xml文件,并使用JAVA的JAXB技术完成xml的解析...

    首先下载oxygen软件(Oxygen XML Editor),目前使用的是试用版(可以安装好软件以后get trial licence,获得免费使用30天的权限,当然这里鼓励大家用正版软件!!!) ...

最新文章

  1. 安卓 发送短信两种方式
  2. 解决windows文件在linux系统中显示乱码的问题
  3. 【语法】点语法的应用
  4. 3.Vue 条件渲染
  5. Java多线程知识小抄集(一)
  6. 如何快速定位SAP CRM订单应用(Order Application)错误消息抛出的准确位置
  7. C# 与java区别总结 收集
  8. win10任务栏和开始菜单_如何将网站固定到Windows 10任务栏或开始菜单
  9. python协成_Python协程(上)
  10. Tree UVA - 548(二叉树递归遍历)
  11. 如何用python做一个时钟_Python使用turtle库制作一个时钟
  12. 深度学习:注意力模型Attention Model
  13. 如何生成白底一寸照?怎么制作白底证件照?
  14. mxh缩写英语_mxh的含义,mxh是什么的缩写,mxh的词语,mxh代表的意思
  15. wifi卡慢延迟高_如何解决WiFi又慢又卡
  16. 简道云-灵活易用的应用搭建平台
  17. 快给你的Vue项目添加一个编辑图片组件吧
  18. Rollup项目的SNARK景观
  19. HI3861学习笔记(12)——GPIO输入接口使用
  20. CorelDRAW 2023版本更新内容及安装详细教程

热门文章

  1. C# 词典数据结构设计【附demo】
  2. Windows 2003安装IIS无法复制CONVLOG.EXECONVLOG.EX_问题
  3. 我最大的乐趣是不厌其烦地收集人生的各种经历和体验。我喜欢享受人生的各种经历和体验所带给我的难以言表的乐趣...
  4. 46 - 算法 - Leetcode 168 -26进制 --减一
  5. Java算法之最大子序和
  6. 五子棋python设计心得_python五子棋游戏的设计与实现
  7. php 还原html,可恢复代码的HTML UI元素PHP
  8. 语料库python_NLPPython笔记——语料库
  9. Python批量Excel文件数据导入SQLite数据库的优化方案
  10. Python标准库zlib提供的数据压缩功能