[Java知识库]hjr-JAVA 我为什么使用了swagger

1. 记得最开始和和前端数据对接是写了个word文档，对每个接口进行描述，描述字段，描述返回值
2. 后来有时候改成在线文档了，不用来回qq发送文件一版又一版了
3. 后来用了postman自动生成的描述文档
4. 再后来使用的是 yapi，每次写一个接口都要在系统中维护一个记录，然后字段等修改还需要一直维护
5. 最后我换成了swagger

直接在实体每个字段加好注解

 @ApiModelProperty(dataType = "Long", name = "lineId", value = "线路id")

每个接口加上注解

 @ApiOperation(value = "功能名字", notes = "by_houjinrui；建议传全部参数，id必传")

然后在网页上会自动生成接口描述和实体描述，和前端沟通很方便

点击 Try it out 按钮 还可以直接在线测试接口

在写代码的时候 给每个接口和每个实体加好注解

然后直接访问swagger配置的网址

然后就自动生成了一个网页，直接给前端看这个网址即可

网页包含三个最重要的功能

1. 实体的每个字段的描述
2. 每个接口传参返回值的描述
3. 在线点击一下直接测试到接口