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

简介: 利用ApiPost一键、快速生成接口文档!妈妈再也不用担心自己女孩纸们没有时间过38节啦!
对于我们这些程序员和程序媛来讲,最头疼的莫过于写文档。

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

我们可都是正个八经的理工校草和理工女神,研究github、逛逛csdn、写hello world是才我们的拿手菜,写文档是文科生的事情好不啦?(手动吐哇吐)
今天,教大家一个妙招:利用ApiPost一键、快速生成接口文档!妈妈再也不用担心自己女孩纸们没有时间过38节啦! 52.gif

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


利用ApiPost一键、快速生成接口文档:
当然,你得先下载安装apipost谷歌拓展或者客户端(个人建议客户端)。如图

接下来介绍具体步骤。
1、我们先准备一段接口代码用来测试。如图:
d75b5f5aa212c079b1d3fd55ceb95ce21aa627a6

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

2、接下来,具体操作如下图(全程图片-一看就懂):
5326b1c76768e0941bfebcf66574593dc28bfb65
57debf0669faa661a231088844e197ce85a490be
3、利用全局注释功能,快速创建常见字段的描述
27fe85112b793c6028fca0178f573c785f7fd781
06f7809994ca7c38a67bd3838eae68f8aabcf4f5
5fa632ba1ac8bea4f9ddc38cba4f3910d018fe3b
4、点击顶部的文档模式就可以查看文档了。也可以导出为离线文档。
2722c36f10ac0c5bfbe83f5a26f90fa46685ffd8
2da78d14c0729c908b42d12d434658ef6cee1d28

嗯,好了。
dcca47b87ae7133e9e6dca5787b2e09fdac627c7
女神们,接口文档也生成了,赶紧丢给前端过节去吧!……(^ _ ^)
相关文章
|
JSON 前端开发 安全
Apipost与Apifox对比,会选择谁?
Apipost与Apifox对比,其实两款软件都非常优秀。但从我的需求来说Apifox 似乎更满足我的需求,也更符合我的审美!
4321 0
Apipost与Apifox对比,会选择谁?
|
测试技术
Apifox
体验了一款神器
474 0
Apifox
|
5月前
|
JSON 数据安全/隐私保护 数据格式
SPA项目接口文档
SPA项目接口文档
21 0
|
6月前
|
前端开发 数据可视化 Java
如何快速搞定在线接口文档
该文介绍了如何高效管理在线接口文档,强调了实时更新接口文档对于前后端并行开发的重要性。文中提到了Swagger,一个用于生成、描述和调用RESTful Web服务的框架,它能自动生成接口文档,促进团队协作,并支持功能测试。Springfox是Spring与Swagger的结合,简化了其在项目中的使用。另外,文章推荐了knife4j,这是一个Java MVC框架的Swagger增强工具,小巧、轻量且功能强大,目前被广泛采用。
104 5
|
JSON 前端开发 JavaScript
Apifox,你的API接口文档卷成这样了吗?
使用过Apifox我相信都会被这个软件的细节之处,API接口文档功能强大之处给留下深刻的印象!一个软件工具的使命肯定是要为了使用者的便捷着想,处处的简化使用者的操作让工作更效率,这种才是一种好的工具的表现。
331 0
Apifox,你的API接口文档卷成这样了吗?
|
缓存 监控 负载均衡
为什么需要API接口开发?
为什么需要API接口开发?
|
前端开发 搜索推荐 Java
聊聊接口文档的事儿
聊聊接口文档的事儿
227 0
|
前端开发 JavaScript 搜索推荐
为什么越来越多的人选择Apifox?
为什么越来越多的人选择Apifox?
481 1
为什么越来越多的人选择Apifox?
|
SQL JSON 缓存
接口文档设计的12个注意点! 下
接口文档设计的12个注意点! 下
|
消息中间件 JavaScript 小程序
接口文档设计的12个注意点!
接口文档设计的12个注意点!