Apipost使用心得,让接口文档变得更清晰,更快捷

Idea和Apipost结合使用

Idea 安装插件Apipost-Helper-2.0

在【file】–>【settings】–>【Plugins】搜索 “Apipost-Helper-2.0”–>【install】,重启Idea

编写controller接口

在idea中编写业务功能及接口之后,在controller中鼠标【右键】单击,在弹出的快捷菜单中选择【Upload To ApiPost V2】,
image.png
在弹出的对话框中选择自己要发布接口的项目及路径,如下图所示:
image.png
并点击【ok】,右下角会弹出生成成功的提示,如下图所示:
image.png
点击即可跳转,也可以直接Apipost帐号对应的项目下的路径中就可以看到自己刚才发布的接口,查看接口文档如果输入和输出字段描述不全时,可以根据下面的步骤进行补齐保存即可。

请求参数

是否必填设置

请求参数必填项设置:
image.png
返回参数必填项设置:
image.png

Header参数设置

参数描述列必填,如下图所示:
image.png

Query参数设置

参数描述列必填,如下图所示:
image.png
预览效果如下图所示:
image.png

Body参数设置

参数描述列必填,在body中输入接口请求参数,并点击【提取字段和描述】右侧会出现参数名、参数值、参数描述,需要将参数描述的所有字段给中文描述,方便前端开发人员联调的时候高效开发,如果接口有更新(新增、删除、修改字段需要及时更新接口文档)如下图所示:
image.png预览效果如下图所示:
image.png

响应参数

在【调试】界面点击发送按钮,在接口返回的实时响应中,将响应结果复制,在响应示例中粘贴进去,然后点击右侧的【提取字段和描述】,将字段描述信息列进行补齐。
image.png
预览效果如下图所示:
image.png

生成文档地址

在需要分享的目录上【右键】单击,选择【分享目录】,
image.png
会弹出分享对话框,如下图所示:
image.png
复制外网链接给到前端同事或者API接口文档上,以后就一直用这个地址,会根据接口文档实时更新文档内容,不需要在修改接口文档之后重新分享。

【注意】也可以采用这种方式进行先设计接口文档,接口设计好之后按接口文档进行开发,提倡建议,先设计接口文档,然后在开发接口,前端和后端可以同时进行,达到高效协作目的。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/682033.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

分享10个高质量宝藏网站~

分享一波高质量宝藏网站~ 这10个宝藏网站,个个都好用到爆,娱乐、办公、学习都能在这里找到! 1、Z-Library https://zh.zlibrary-be.se/ 世界最大的免费电子书下载网站!电子书资源超千万,不过这个网站不太稳定&#…

复现NerfingMVS(更新中)

按以下代码一步步操作 conda create -n NerfingMVS python3.7 conda activate NerfingMVS conda install pytorch1.7.1 torchvision0.8.2 torchaudio0.7.2 -c pytorch pip install -r requirements.txthttps://colmap.github.io/install.html Linux 中 建议的依赖&#xff1…

机器学习:基于线性回归、岭回归、xgboost回归、Lasso回归、随机森林回归预测卡路里消耗

前言 系列专栏:机器学习:高级应用与实践【项目实战100】【2024】✨︎ 在本专栏中不仅包含一些适合初学者的最新机器学习项目,每个项目都处理一组不同的问题,包括监督和无监督学习、分类、回归和聚类,而且涉及创建深度学…

如何从未入库的gerrit中撤销一个文件

用一个例子说明 比如有一个提交里面的default.xml的修改没有必要,需要从未入库的gerrit中移除 步骤如下: 1.做reset操作 git reset HEAD^ packages/SettingsProvider/res/values/defaults.xml 2.做checkout操作 git checkout packages/SettingsProv…

从“制造”到“智造”:“灯塔”经验助力中国制造业转型升级-转载

作者:Karel Eloot,侯文皓,Francisco Betti,Enno de Boer和Yves Giraud 作为中国实体经济的主体,制造业是推动中国经济发展乃至全球制造业持续增长的重要引擎。站在历史与未来交汇的新起点上,中国制造业将背…

ASP.NET信息安全研究所设备管理系统的设计与实现

摘 要 以研究所的设备管理系统为背景,以研究所设备管理模式为研究对象,开发了设备管理系统。设备管理系统是设备管理与计算机技术相结合的产物,根据系统的功能需求分析与定义的数据模式,分析了应用程序的主要功能和系统实现的主…

MoviePy(Python音视频开发)

音视频基础帧率、码率、分辨率视频格式H.264和H.265视频压缩算法 Moviepy常见剪辑类VideoFlieClipImageFlieClipColorClipTextClipCompositeVideoClipAudioFlieClipCompositeAudioClip 常见操作音视频的读入与导出截取音视频 音视频基础 帧率、码率、分辨率 体积(V…

中国场外信用衍生产品交易基本术语与适用规则(2022 年版)

中国场外信用衍生产品交易基本术语与适用规则 (2022 年版) 版权所有© 中国银行间市场交易商协会 2022 声 明 中国银行间市场交易商协会(简称“交易商协会”)发布《中国场外信用衍 生产品交易基本术语与适用规则(2…

知从科技应邀参加恩智浦技术日巡回研讨会郑州站汽车电子专场

4月18日,恩智浦技术日巡回研讨会的首个汽车电子专场在郑州成功举办。此次研讨会汇聚了众多行业专家,聚焦前沿的赋能技术,共同探讨汽车电子架构、ADAS、汽车电气化、车载信息娱乐系统、UWB超宽带等热门应用。作为恩智浦合作伙伴,知…

Python运维之多进程!!

本节的快速导航目录如下喔!!! 一、创建进程的类Process 二、进程并发控制之Semaphore 三、进程同步之Lock 四、进程同步之Event 五、进程优先队列Queue 六、多进程之进程池Pool 七、多进程之数据交换Pipe 一、创建进程的类Process mu…

【 npm详解:从入门到精通】

文章目录 npm详解:从入门到精通1. [npm](https://www.npmjs.com/)的安装2. npm的基础用法2.1 初始化项目2.2 安装依赖2.3 卸载依赖2.4 更新依赖 3. npm的高级用法3.1 运行脚本3.2 使用npm scope3.3 使用npm link 4. npm资源5. 使用npm进行依赖树分析和可视化6. npm进…

虚拟机镜像文件qcow2格式转vmdk

一、在esxi上虚拟机导出qcow2镜像文件 1、卸载数据盘、网卡 2、登录虚拟机所在物理服务器,查找系统盘名为vm-101-disk-0的文件位置 find / -name "vm-101-disk-0"使用命令导出qcow2镜像(进度条走完就完成了): qemu…