时间:2021-05-20
前后端分离的项目,接口文档的存在十分重要。与手动编写接口文档不同,swagger是一个自动生成接口文档的工具,在需求不断变更的环境下,手动编写文档的效率实在太低。与新版的swagger3相比swagger2配置更少,使用更加方便。
一、pom文件中引入Swagger3依赖
二、Application上面加入@EnableOpenApi注解
三、Swagger3Config的配置
四、Swagger注解的使用说明
Controller层的配置:
@Api(tags = "用户信息管理")@RestController@RequestMapping("userRecord")public class UserRecordController extends ApiController { /** * 服务对象 */ @Resource private UserRecordService userRecordService; /** * 分页查询所有数据 * @param page 分页对象 * @param userRecord 查询实体 * @return 所有数据 */ @ApiOperation("分页查询所有数据") @GetMapping("page") public R selectAll(Page<UserRecord> page, UserRecord userRecord) { return success(this.userRecordService.page(page, new QueryWrapper<>(userRecord))); } /** * 通过主键查询单条数据 * @param id 主键 * @return 单条数据 */ @ApiOperation("通过主键查询单条数据") @GetMapping("{id}") public R selectOne(@PathVariable Serializable id) { return success(this.userRecordService.getById(id)); } /** * 新增数据 * @param userRecord 实体对象 * @return 新增结果 */ @ApiOperation("新增数据") @PostMapping("insert") public R insert(@RequestBody UserRecord userRecord) { return success(this.userRecordService.save(userRecord)); } /** * 修改数据 * @param userRecord 实体对象 * @return 修改结果 */ @ApiOperation("修改数据") @PutMapping("update") public R update(@RequestBody UserRecord userRecord) { return success(this.userRecordService.updateById(userRecord)); } /** * 删除数据 * @param idList 主键结合 * @return 删除结果 */ @ApiOperation("删除数据") @DeleteMapping("delete") public R delete(@RequestParam("idList") List<Long> idList) { return success(this.userRecordService.removeByIds(idList)); }}五、Swagger界面效果
Swagger的访问路径由port/swagger-ui.html改成了port/swagger-ui/ 或port/swagger-ui/index.html,项目演示代码在springboot-swagger
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
声明:本页内容来源网络,仅供用户参考;我单位不保证亦不表示资料全面及准确无误,也不保证亦不表示这些资料为最新信息,如因任何原因,本网内容或者用户因倚赖本网内容造成任何损失或损害,我单位将不会负任何法律责任。如涉及版权问题,请提交至online#300.cn邮箱联系删除。
前言本篇文章主要介绍的是SpringBoot整合Swagger(API文档生成框架)和SpringBoot整合Actuator(项目监控)使用教程。Spring
这篇文章主要介绍了springboot2整合swagger-ui过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友
Swagger是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。本文简单介绍了在项目中集成swagger的方法和一些常见问题。如果想深入分析项目源码
SpringBoot整合Gson整合Fastjson一、SpringBoot整合Gson1、pom依赖#在SpringBoot中给我们自带了json解析器,我们
SwaggerUi是一个自动生成接口文档,并且还可以去测试这些接口的东西。SpringBoot集成SwaggerUi引入依赖2.6.1org.springfra