干掉 Swagger,试试这个!
点击上方“朱小厮的博客”,选择“设为星标”
后台回复"加群",加入新技术
JApiDocs是一个无需额外注解、开箱即用的SpringBoot接口文档生成工具。
编写和维护API文档这个事情,对于后端程序员来说,是一件恼人但又不得不做的事情,我们都不喜欢写文档,但除非项目前后端代码都是自己写的,否则API文档将是前后端协作中一个不可或缺的沟通界面。既然不可避免,那就想办法弄个轮子吧。人生苦短,必须偷懒。
无图无真相,生成文档的效果如下:
相比Swagger要写一堆注解,Spring RestDocs需要写测试用例,才能生成API文档。JApiDocs 具有无痛集成的特点,你只需花几分钟就能知道它怎么用了。
快速开始
要使得JApiDcos正确工作,你写的代码应该是像下面的样子的:
/*** 用户接口*/
@RequestMapping("/api/user/")
@RestController
public class UserController {/*** 用户列表* @param listForm*/@RequestMapping(path = "list", method = {RequestMethod.GET, RequestMethod.POST} )public ApiResult<PageResult<UserVO>> list(UserListForm listForm){return null;}/*** 保存用户* @param userForm*/@PostMapping(path = "save")public ApiResult<UserVO> saveUser(@RequestBody UserForm userForm){return null;}
}
我们给Controller类和方法加上必要的注释,给接口方法返回相关的对象类型。是的,这样JApiDocs就能解析到相关的接口信息了,就跟我们平时写的代码是差不多的,但要注意,你要通过@param
来告诉JApiDocs接口的参数,但在IDE的帮助下,这个工作将是轻松愉悦的:
然后你在任意一个main入口方法执行下面的代码就可以生成文档了:
DocsConfig config = new DocsConfig();
config.setProjectPath("your springboot project path"); // 项目根目录
config.setProjectName("ProjectName"); // 项目名称
config.setApiVersion("V1.0"); // 声明该API的版本
config.setDocsPath("your api docs path"); // 生成API 文档所在目录
config.setAutoGenerate(Boolean.TRUE); // 配置自动生成
Docs.buildHtmlDocs(config); // 执行生成文档
接下来你只管好好写代码,生成Api文档的工作就可以交给JApiDocs了,你不需要再为额外编写和维护文档而烦恼。
功能特性
1、代码即文档
JApiDocs是通过直接解析SpringBoot的源码语法来工作的,所以只要Controller的语法符合一定的代码规范,有合理的注释,就可以直接导出文档。
2、支持导出HTML
便捷的导航和接口查看界面;可本地预览,或者部署到HTTP服务器。推荐部署到服务器,方便前后端展开协作。
3、同步导出客户端Model代码
支持导出Android端的 Java 和iOS端的 Object C Model代码,减少前端程序员的重复编码工作。
4、更多特性
支持接口搜索;支持不同版本和英文文档;自定义扩展等。
简洁的文档
再好用的东西,如果没有文档说明,别人也无从入手。为了让大家尽快上手,JApiDocs准备了一份极简的文档说明,确保你在几分钟就能用上JApiDocs。花5分钟不到就能认识一个提高工作效率的工具,让你把更多的时间花在更加有价值的事情上,你确认不看一下吗?
仓库地址:https://github.com/YeDaxia/JApiDocs
中文文档:https://japidocs.agilestudio.cn/#/zh-cn/
想知道更多?扫描下面的二维码关注我
后台回复”加群“获取公众号专属群聊入口
更新一下当当618图书优惠码:“实付满150再减30”的优惠码「 YREFVG 」或者 「 NSRM2M 」,(使用时间:6.9 - 6.20 ,使用渠道:当当小程序或当当APP)。以前的是“实付200-30”,这次更加给力点。
点个在看少个 bug ????
干掉 Swagger,试试这个!相关推荐
- 干掉 Swagger + Postman?测试接口直接生成API文档,这个国产文档工具真香!
点击上方"芋道源码",选择"设为星标" 管她前浪,还是后浪? 能浪的浪,才是好浪! 每天 10:33 更新文章,每天掉亿点点头发... 源码精品专栏 原创 | ...
- 干掉 Swagger (丝袜哥),试试这个新工具!
点击上方 好好学java ,选择 星标 公众号 重磅资讯.干货,第一时间送达 今日推荐:硬刚一周,3W字总结,一年的经验告诉你如何准备校招! 个人原创100W+访问量博客:点击前往,查看更多 JApi ...
- 干掉RESTful:GraphQL真香!
点击上方"朱小厮的博客",选择"设为星标" 后台回复"书",获取近百本电子书入口 封面:重庆洪崖洞 来源:http://suo.im/5W1 ...
- 深度好文:Netflix奈飞微服务架构设计解析
点击上方"朱小厮的博客",选择"设为星标" 后台回复"书",获取 来源:22j.co/dz54 1 概述 数年来,Netflix 一直是全球 ...
- 搞懂这些SQL优化技巧,面试横着走
点击上方"朱小厮的博客",选择"设为星标" 后台回复"书",获取 来源:sohu.gg/FGG98 SQL 优化已经成为衡量程序猿优秀与否的 ...
- 全世界最顶级的开发者都在使用什么数据库
点击上方"朱小厮的博客",选择"设为星标" 后台回复"书",获取 来源:22j.co/cCMD 作为一名IT行业从业者,其实从去年已经隐隐约 ...
- 卧槽,又一款Markdown组合神器!!!
点击上方"朱小厮的博客",选择"设为星标" 后台回复"书",获取 来源:/urlify.cn/IjaU3a Typora 是专注于编写 Ma ...
- 后端不哭!最新优化性能经验分享来啦
点击上方"朱小厮的博客",选择"设为星标" 后台回复"书",获取 来源:22j.co/cBd7 今天谈下业务系统性能问题分析诊断和性能优化方 ...
- 今天才知道,MySQL 的 binlog 编号可以这么大!
点击上方"朱小厮的博客",选择"设为星标" 后台回复"书",获取 来源:22j.co/bYaE 每个binlog文件都有编号,从最早的3位数 ...
最新文章
- 面试被问到秒杀系统,这个点你一定得答到!
- 吴恩达《优化深度神经网络》精炼笔记(3)-- 超参数调试、Batch正则化和编程框架...
- vs 2019 aspx灰色_蛇纹当道,豹纹在侧:穿成动物园是2019时尚大势?
- python 包编译安装mysql_CentOS7编译安装MySQL8.0.23和Python3.1.9
- 【转】Oracle DECODE函数的语法介绍
- Android studio 去除软件运行时顶部原有的蓝色/绿色框
- 离职后前公司老大叫我回去帮忙,怎么委婉拒绝?
- 彩色证件照片常用的红色、蓝色背景颜色值
- 优化AI搜索引擎,从这3个领域入手!
- Predicting Lymph Node Metastasis Using Histopathological Images Based on Multiple Instance Learning
- 智慧停车(三) IOT选型-电信物联网
- STM32 高级定时TIM 死区时间计算--C语言实现
- ps如何增加可撤回的步数
- 数据库ER图该怎么画
- 华为MPLS L2xxx(PWE3)+静动混合多跳PW实验
- 2017lol服务器维修时间,lol年3月16日要维护多长时间2017_lol3.16维护时间公告_好特教程...
- 湖南高职计算机专业排名6,湖南省高职院校排行榜_2019年湖南省高职院校名单
- 金蝶KS客户端无法安装,提示“iKernel.exe时出错”
- ChatGPT在企业中的应用
- wireshark网络安全分析工具之万文多图详解(持续更新)
热门文章
- excel转html放在tomcat,Excel转web!把excel在线打开??
- s5原生android 5.0,三星Galaxy S5升级Android 5.0:美味棒棒糖
- 用oracle怎么测试,oracle – 如何(单位)测试数据密集的PL / SQL应用程序
- python3怎么使用qstring_请问PyQt的QString和python的string的区别?
- 64位计算机安装32位,64位电脑装32位系统,小编教你64位电脑怎么装32位系统
- 【SpringBoot零基础案例04】【IEDA 2021.1】SpringBoot核心配置文件appilcation.yml或application.yaml
- 有n个人围成一圈,按顺序从1到n编号。从第一个人开始报数
- 硬盘的原理以及SQL Server如何利用硬盘原理减少IO
- ionic - error
- sshd_config配置详解