专栏首页ApiPost利用ApiPost一键、快速生成接口文档!女猿也过38节!
原创

利用ApiPost一键、快速生成接口文档!女猿也过38节!

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

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

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

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

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

ApiPost简介:

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

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

如果你对ApiPost了解不多,可以戳这里:https://cloud.tencent.com/developer/article/1399828

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

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

接下来介绍具体步骤。

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

一个简单的测试接口

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

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

发送结果
参数描述填写

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

添加全局注释
添加全局注释
添加全局注释

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

查看接口文档
导出接口文档

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

原创声明,本文系作者授权云+社区发表,未经许可,不得转载。

如有侵权,请联系 yunjia_community@tencent.com 删除。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 利用ApiPost接口调试与文档生成工具,提升前、后端工作效率

    对于我们后端程序员,常常会写一些接口(APIs),但是在前端尚未调用之前,我们必须先自己测试下这个接口是不是正确返回了预定结果。对于一个GET请求的接口还好,我...

    骑马的少年
  • ApiPost自动化测试基础之:如何使用测试校验(测试用例)?

    我们在《ApiPost的环境变量的定义和使用》和《ApiPost自动化测试基础之:接口参数依赖的情景处理》分别讲解了ApiPost环境变量的定义、使用以及基于环...

    骑马的少年
  • 40个只有程序员才看得懂的段子

    1. 一程序员去面试,面试官问:“你毕业才两年,这三年工作经验是怎么来的?!”程序员答:“加班。” ? 2. 某程序员对书法十分感兴趣,退休后决定在这方面有所建...

    Spark学习技巧
  • 40个只有程序员才看得懂的段子

    1. 一程序员去面试,面试官问:“你毕业才两年,这三年工作经验是怎么来的?!”程序员答:“加班。”

    Java帮帮
  • 使用ApiPost模拟发送get、post、delete、put等http请求

    现在的模拟发送请求插件很多比如老外的postman等,但亲测咱们国内的 ApiPost 更好用一些,因为它不仅可以模拟发送get、post、delete、put...

    骑马的少年
  • 好用的在线HTTP接口测试 - HTTP GET/POST模拟请求测试工具-ApiPost

    现在的模拟发送请求插件很多比如老外的postman等,但亲测咱们国内的 ApiPost 更好用一些,因为它不仅可以模拟发送get、post、delete、put...

    骑马的少年
  • 接口工具分析

    系统对外的接口:比如你要从别的网站或服务器上获取资源或信息,别人肯定不会把 数据库共享给你,他只能给你提供一个他们写好的方法来获取数据,你引用他提供的接口就能使...

    用户7880705
  • ApiPost的环境变量的定义和使用「ApiPost环境变量」

    新版的ApiPost(Chrome拓展V2.0.8+/客户端V2.2.1+)已经支持环境变量的定义和使用。

    骑马的少年
  • 利用在线HTTP接口测试工具ApiPost,模拟移动端请求API接口

    比如,当一个API需要根据用户不同的终端来返回不同的数据时,就需要一个工具来模拟不同的终端了。

    骑马的少年

扫码关注云+社区

领取腾讯云代金券