swagger学习笔记

一、SpringBoot集成Swagger

SpringBoot集成Swagger => springfox,两个jar包

Springfox-swagger2

swagger-springmvc

使用Swagger

要求:jdk 1.8 + 否则swagger2无法运行

步骤:

1、新建一个SpringBoot-web项目

2、添加Maven依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
<dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-swagger2</artifactId>
   <version>2.9.2</version>
</dependency>
<!-- 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>

3、编写HelloController,测试确保运行成功!

4、要使用Swagger,我们需要编写一个配置类-SwaggerConfig来配置 Swagger

@Configuration //配置类
@EnableSwagger2// 开启Swagger2的自动配置
public class SwaggerConfig {  
}

5、访问测试 :http://localhost:8080/swagger-ui.html ,可以看到swagger的界面;
在这里插入图片描述

二、配置Swagger

1、Swagger实例Bean是Docket,所以通过配置Docket实例来配置Swaggger。

@Bean //配置docket以配置Swagger具体参数
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2);
}

2、可以通过apiInfo()属性配置文档信息

   //配置sqagger信息=apiInfo
    private ApiInfo apiInfo(){
    Contact contact = new Contact("联系人名字", "http://xxx.xxx.com/联系人访问链接", "联系人邮箱");
        return new ApiInfo(
           "HL的第一个文档",  // 标题
           "做一个干净帅气的程序员", // 描述
           "1.0", // 版本
           "http://terms.service.url/组织链接", // 组织链接
           contact, // 联系人信息
           "Apach 2.0 许可", // 许可
           "许可链接", // 许可连接
           new ArrayList<>()// 扩展
    }

3、Docket 实例关联上 apiInfo()

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo());
}

4、重启项目,访问测试 http://localhost:8080/swagger-ui.html 看下效果;

三、配置扫描接口

1、构建Docket时通过select()方法配置怎么扫描接口。

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.hl.swagger.controller"))
      .build();
}

2、重启项目测试,由于我们配置根据包的路径扫描接口,所以我们只能看到一个类.
3、除了通过包路径配置扫描接口外,还可以通过配置其他方式扫描接口,这里注释一下所有的配置方式:(注:均是该类下面的RequestHandlerSelectors的方法)

any() // 扫描所有,项目中的所有接口都会被扫描到
none() // 不扫描接口
// 通过方法上的注解扫描,如withMethodAnnotation(GetMapping.class)只扫描get请求
withMethodAnnotation(final Class<? extends Annotation> annotation)
// 通过类上的注解扫描,如.withClassAnnotation(Controller.class)只扫描有controller注解的类中的接口
withClassAnnotation(final Class<? extends Annotation> annotation)
basePackage(final String basePackage) // 根据包路径扫描接口

4、除此之外,我们还可以配置接口扫描过滤:

@Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.hl.swagger.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/hl开头的接口
      .paths(PathSelectors.ant("/hl/**"))
      .build();
}

5、PathSelectors的可选值还有

any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制
ant(final String antPattern) // 通过ant()控制

四、配置Swagger开关

1、通过enable()方法配置是否启用swagger,如果是false,swagger将不能在浏览器中访问了

 @Bean
public Docket docket() {
   return new Docket(DocumentationType.SWAGGER_2)
      .apiInfo(apiInfo())
      .enable(false) //配置是否启用Swagger,如果是false,在浏览器将无法访问
      .select()// 通过.select()方法,去配置扫描接口,RequestHandlerSelectors配置如何扫描接口
      .apis(RequestHandlerSelectors.basePackage("com.hl.swagger.controller"))
       // 配置如何通过path过滤,即这里只扫描请求以/hl开头的接口
      .paths(PathSelectors.ant("/hl/**"))
      .build();
}

2、如何动态配置当项目处于test、dev环境时显示swagger,处于pro时不显示?

  @Bean
    public Docket docket(Environment environment){
 
        // 设置要显示swagger的环境
	    Profiles of = Profiles.of("dev", "test");
	    // 判断当前是否处于该环境
	    // 通过 enable() 接收此参数判断是否要显示
	    boolean b = environment.acceptsProfiles(of);
	   
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("HL")  //搜索框里的默认值
                .enable(flag)   //是否启动swagger
                .select()
                //.apis(RequestHandlerSelectors.basePackage("com.example.swagger_demo.controller"))  //扫描基础包
                .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))  //根据注解来扫描
                .paths(PathSelectors.ant("/**"))  //过滤路径
                .build();

    }

3、可以在项目中增加一个dev的配置文件查看效果!

五、搜索框配置API分组

1、如果没有配置分组,默认是default。通过groupName()方法即可配置分组:
在这里插入图片描述2、如何配置多个分组?配置多个分组只需要配置多个docket即可:

@Bean
public Docket docket1(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("A");
}
@Bean
public Docket docket2(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("B");
}
@Bean
public Docket docket3(){
   return new Docket(DocumentationType.SWAGGER_2).groupName("C");
}

3、重启项目查看即可

六、实体配置

1、新建一个实体类

//@ApiModel为类添加注释
//@ApiModelProperty为类属性添加注释
@ApiModel("用户实体类")
public class Person {
    @ApiModelProperty("用户名")
    private String uername;
    @ApiModelProperty("密码")
    private String password;
}

2、只要这个实体在请求接口的返回值上(即使是泛型),都能映射到实体项中:

@RequestMapping("/getPerson")
public Person getUser(){
   return new Person ();
}

3、重启查看测试
在这里插入图片描述

七、常用注解、

Swagger的所有注解定义在io.swagger.annotations包下

下面列一些经常用到的,未列举出来的可以另行查阅说明:

Swagger注解Swagger注解
@ApiOperation(“xxx接口说明”)作用在接口方法上
@ApiModel(“xxxPOJO说明”)作用在模型类上:如VO、BO
@ApiModelProperty(value = “xxx属性说明”,hidden = true)作用在类方法和属性上,hidden设置为true可以隐藏该属性
@ApiParam(“xxx参数说明”)作用在参数、方法和字段上,类似@ApiModelProperty

eg:

 	//@ApiOperation不能放在类上,只能放在方法上
    //当swagger时get请求的时候,需要加入@RequestParam注解
    @ApiOperation(value = "hello控制类",httpMethod = "GET")
    @GetMapping(value = "/sayHello" )
    public String sayHello(@RequestParam @ApiParam("用户名") String username){
        return "hello"+username;
    }

该文章借鉴以下链接:

https://mp.weixin.qq.com/s/0-c0MAgtyOeKx6qzmdUG0w

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值