SpringBoot整合Swagger3生成接口文档过程解析

 更新时间:2020年07月21日 10:50:42   作者:陈大帅哥Ray  
这篇文章主要介绍了SpringBoot整合Swagger3生成接口文档过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

  前后端分离的项目,接口文档的存在十分重要。与手动编写接口文档不同,swagger是一个自动生成接口文档的工具,在需求不断变更的环境下,手动编写文档的效率实在太低。与新版的swagger3相比swagger2配置更少,使用更加方便。

一、pom文件中引入Swagger3依赖

<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-boot-starter</artifactId>
   <version>3.0.0</version>
</dependency>

二、Application上面加入@EnableOpenApi注解

@EnableOpenApi
@SpringBootApplication
@MapperScan(basePackages = {"cn.ruiyeclub.dao"})
public class Swagger3Application {
  public static void main(String[] args) {
    SpringApplication.run(Swagger3Application.class, args);
  }
}

三、Swagger3Config的配置

@Configuration
public class Swagger3Config {
  @Bean
  public Docket createRestApi() {
    return new Docket(DocumentationType.OAS_30)
        .apiInfo(apiInfo())
        .select()
        .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class))
        .paths(PathSelectors.any())
        .build();
  }

  private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("Swagger3接口文档")
        .description("更多请咨询服务开发者Ray。")
        .contact(new Contact("Ray。", "http://www.ruiyeclub.cn", "ruiyeclub@foxmail.com"))
        .version("1.0")
        .build();
  }
}

四、Swagger注解的使用说明

@Api:用在请求的类上,表示对类的说明
  tags="说明该类的作用,可以在UI界面上看到的注解"
  value="该参数没什么意义,在UI界面上也看到,所以不需要配置"

@ApiOperation:用在请求的方法上,说明方法的用途、作用
  value="说明方法的用途、作用"
  notes="方法的备注说明"

@ApiImplicitParams:用在请求的方法上,表示一组参数说明
  @ApiImplicitParam:用在@ApiImplicitParams注解中,指定一个请求参数的各个方面
    name:参数名
    value:参数的汉字说明、解释
    required:参数是否必须传
    paramType:参数放在哪个地方
      · header --> 请求参数的获取:@RequestHeader
      · query --> 请求参数的获取:@RequestParam
      · path(用于restful接口)--> 请求参数的获取:@PathVariable
      · body(不常用)
      · form(不常用)  
    dataType:参数类型,默认String,其它值dataType="Integer"    
    defaultValue:参数的默认值

@ApiResponses:用在请求的方法上,表示一组响应
  @ApiResponse:用在@ApiResponses中,一般用于表达一个错误的响应信息
    code:数字,例如400
    message:信息,例如"请求参数没填好"
    response:抛出异常的类

@ApiModel:用于响应类上,表示一个返回响应数据的信息
      (这种一般用在post创建的时候,使用@RequestBody这样的场景,
      请求参数无法使用@ApiImplicitParam注解进行描述的时候)
  @ApiModelProperty:用在属性上,描述响应类的属性

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

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • 关于Spring的统一功能处理(拦截器)实现

    关于Spring的统一功能处理(拦截器)实现

    这篇文章主要介绍了关于Spring的统一功能处理(拦截器)实现,每个方法中都要单独写用户登录验证的方法,即使封装成公共方法,也一样要传参调用和在方法中进行判断,需要的朋友可以参考下
    2023-05-05
  • Java并发编程之ReentrantLock可重入锁的实例代码

    Java并发编程之ReentrantLock可重入锁的实例代码

    这篇文章主要介绍了Java并发编程之ReentrantLock可重入锁的实例代码,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-02-02
  • mac下修改idea的jvm运行参数解决idea卡顿的情况

    mac下修改idea的jvm运行参数解决idea卡顿的情况

    这篇文章主要介绍了mac下修改idea的jvm运行参数解决idea卡顿的情况,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2023-12-12
  • 什么是Java自旋锁

    什么是Java自旋锁

    这篇文章主要介绍了什么是Java自旋锁,在有些场景中,同步资源的锁定时间很短,为了这一小段时间去切换线程,线程挂起和恢复现场的花费可能会让系统得不偿失,下面来了解具体内容介绍吧
    2022-01-01
  • 基于springboot实现一个简单的aop实例

    基于springboot实现一个简单的aop实例

    这篇文章主要介绍了基于springboot实现一个简单的aop,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-11-11
  • 详解MyBatisPlus如何实现分页和查询操作

    详解MyBatisPlus如何实现分页和查询操作

    这篇文章主要为大家详细介绍了MyBatisPlus是如何实现分页和查询操作的,文中的示例代码讲解详细,对我们学习有一定的帮助,需要的可以参考一下
    2022-05-05
  • SpringBoot定制三种错误页面及错误数据方法示例

    SpringBoot定制三种错误页面及错误数据方法示例

    Spring Boot提供的默认异常处理机制通常并不一定适合我们实际的业务场景,因此,我们通常会根据自身的需要对Spring Boot全局异常进行统一定制,例如定制错误页面,定制错误数据等。本文主要介绍了SpringBoot三种自定义错误页面的实现,快来学习吧
    2021-12-12
  • java Object wait方法详细介绍

    java Object wait方法详细介绍

    这篇文章主要介绍了java Object wait方法详细介绍的相关资料,需要的朋友可以参考下
    2017-02-02
  • Mybatis在注解上如何实现动态SQL

    Mybatis在注解上如何实现动态SQL

    这篇文章主要介绍了Mybatis在注解上如何实现动态SQL,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06
  • 使用java生成激活码和密钥的方法

    使用java生成激活码和密钥的方法

    本文主要介绍了java生成激活码和密钥的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-05-05

最新评论