Swagger使用

步骤1:构建SpringBoot项目

  1. 新建"Spring Initializr"
  2. 添加"Spring Web"模块

步骤2:导包(Maven)

方式1:swagger2 V2.x.x

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>

方式2:swagger2 V3.x.x

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

步骤3:新增pojo类

  1. 新增需要的实体类

步骤4:新增Controller类

  1. 新增对应的 类和它的接口 (即@Controller,@RequestMapping等)
  2. 将需要的实体类也注册为接口

步骤5:新增Swagger配置类

  1. 类上加上@Configuration(注册Bean)
  2. 类上加上@EnableSwagger2(启动Swagger)
  3. 新增返回Docket的方法,并@Bean
  1. Docket的构造器用到ApiInfo类,新增一个获取ApiInfo的方法
  2. Docket对获取哪些类的接口进行设置(扫描)同时注册了多个Docket可以完成分组操作,ApiInfo记录作者信息

步骤6:启动项目进入swagger-ui测试

  1. 进入"项目默认URL/swagger-ui.html"
  2. 查看分组和选中的组的接口
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值