Fork me on GitHub

Swagger使用

字数统计: 1.3k字   |   阅读时长≈ 5分

Swagger

前后端分离：前端在不需要后端的情况下可以独立启动，数据的获取其实就是使用json或者js文件 伪造了一份 后端demo数据

以前前端写好模板给到后端，所以不需要前端人员和后端人员进行api的交互， 分离后前端和后端相当于独立开发 那么前端与后端的交互现在就需要统一api，Swagger就是干这个使的

指定schema 实时更新api

号称世界上最流行的api框架

RestFul Api 文档在线生成工具=》api文档与api定义同步更新

直接运行，可以在线测试api接口

支持多种语言 java ，php

java集成

需要两个jar

​ Swagger2

​ UI

pom.xml

1
2
3
4
5
6
7
8
9
10
11
12

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>2.9.2</version>
</dependency>

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>2.9.2</version>
</dependency>

使用

1
2
3
4
5
6
7
8
9
10
11
12
13
14

@Configuration
@EnableSwagger2 //开启swagger2（新版的swagger）
public class SwaggerConfig {



}
启动springboot项目
   访问 http://localhost:8080/swagger-ui.html#/



swagger的ui界面的html在 swagger-ui这个jar包下的meta-inf/swagger-ui.html

配置swagger

swagger 的bean 实例 Docket

api info
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

//这是他默认的
public static final ApiInfo DEFAULT = new ApiInfo("Api Documentation", "Api Documentation", "1.0", "urn:tos",
          DEFAULT_CONTACT, "Apache 2.0", "http://www.apache.org/licenses/LICENSE-2.0", new ArrayList<VendorExtension>());


如果我们需要自定义那么就像这个默认的一样去new一个对象传入对应的参数，然后 
    new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfoInstance);


private ApiInfo createApiInfo(){

        //contact 是作者信息
        Contact contact = new Contact("忘忧症", "https://nepentheszgw.github.io/", "2960571342@qq.com");
        return new ApiInfo(
                "Api 标题",
                "Api描述",
                "版本号1.0",
                "https://www.baidu.com",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList<VendorExtension>());
    }
配置要扫描的接口
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

@Bean
  public Docket docket(){
      return new Docket(DocumentationType.SWAGGER_2)
              .apiInfo(createApiInfo())
              //获取一个构建Docket的builder
              .select()
              //配置要扫描的api接口 的位置
              //basePackage :扫描指定包下的Mapping
              //any() 扫描全部
              // none() 不扫描
              //withMethodAnnotation 扫描方法上的注解
              // withClassAnnotation 扫描类上的注解
              .apis(RequestHandlerSelectors.basePackage("com.zgw.springbootcode.controller"))
              // 配置 api 接口的url
              // ant("/") 把servlet请求路径是指定路径相同的 api 提取出来
              //any() 所有的
              //none() 全部都不提取出来
              //regex() 使用正则匹配
              .paths(PathSelectors.ant("/**"))
              .build();
  }
配置是否启动
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

@Bean
  public Docket docket(){
      return new Docket(DocumentationType.SWAGGER_2)
              .apiInfo(createApiInfo())
              //是否启动swagger，false为不启动
              .enable(false)
              //获取一个构建Docket的builder
              .select()
              //配置要扫描的api接口 的位置
              //basePackage :扫描指定包下的Mapping
              //any() 扫描全部
              // none() 不扫描
              //withMethodAnnotation 扫描方法上的注解
              // withClassAnnotation 扫描类上的注解
              .apis(RequestHandlerSelectors.basePackage("com.zgw.springbootcode.controller"))
              // 配置 api 接口的url
              // ant("/") 把servlet请求路径是指定路径相同的 api 提取出来
              //any() 所有的
              //none() 全部都不提取出来
              //regex() 使用正则匹配
              .paths(PathSelectors.ant("/**"))
              .build();
  }
配置生产环境关闭
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

@Bean
   public Docket docket(Environment environment){

       //是不是在开发环境，如果是，则会返回true，否则返回false
       boolean dev = environment.acceptsProfiles(Profiles.of("dev"));

       return new Docket(DocumentationType.SWAGGER_2)
               .apiInfo(createApiInfo())
               //是否启动swagger，false为不启动
               .enable(dev)
               //获取一个构建Docket的builder
               .select()
               //配置要扫描的api接口 的位置
               //basePackage :扫描指定包下的Mapping
               //any() 扫描全部
               // none() 不扫描
               //withMethodAnnotation 扫描方法上的注解
               // withClassAnnotation 扫描类上的注解
               .apis(RequestHandlerSelectors.basePackage("com.zgw.springbootcode.controller"))
               // 配置 api 接口的url
               // ant("/") 把servlet请求路径是指定路径相同的 api 提取出来
               //any() 所有的
               //none() 全部都不提取出来
               //regex() 使用正则匹配
               .paths(PathSelectors.ant("/**"))
               .build();
   }
设置组
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
多个组就是多个@bean 然后返回多个Docket对象 

  @Bean
    public Docket docket(Environment environment){

        boolean dev = environment.acceptsProfiles(Profiles.of("dev"));

        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(createApiInfo())
                .groupName("忘忧症")
                //是否启动swagger，false为不启动
                .enable(dev)
                //获取一个构建Docket的builder
                .select()
                //配置要扫描的api接口 的位置
                //basePackage :扫描指定包下的Mapping
                //any() 扫描全部
                // none() 不扫描
                //withMethodAnnotation 扫描方法上的注解
                // withClassAnnotation 扫描类上的注解
                .apis(RequestHandlerSelectors.basePackage("com.zgw.springbootcode.controller"))
                // 配置 api 接口的url
                // ant("/") 把servlet请求路径是指定路径相同的 api 提取出来
                //any() 所有的
                //none() 全部都不提取出来
                //regex() 使用正则匹配
                .paths(PathSelectors.ant("/**"))
                .build();
    }

生成model

只要 controller的返回类型是一个自定义对象，就会被加载进来

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
public class MyUser {
    
    private Integer age;
    private String name;
    注意没有getset方法 不会把私有属性显示出来的
        
}


  @GetMapping("/user")
    public MyUser user(){
        return new MyUser();
    }


如果想给实例类加注释
    
    @ApiModel("我是user实体类")
public class MyUser {

    @ApiModelProperty("我是age属性")
    private Integer age;
    @ApiModelProperty("我是name属性")
    private String name;
    
      public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }
}

接口上注释

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
    
//就是加一个这个请求的api接口的描述
@ApiOperation("我是hello")
    @GetMapping("/user")
    public MyUser user(){
        return new MyUser();
    }


api接口参数注释
    
    
    @ApiOperation("我是hello")
    @GetMapping("/user")
    public MyUser user(@ApiParam("用户名") String username){
        return new MyUser();
    }
赏

谢谢你请我吃糖果

支付宝
微信

扫一扫，分享到微信

tag:

    缺失模块。
    1、请确保node版本大于6.2
    2、在博客根目录（注意不是yilia-plus根目录）执行以下命令：
    npm i hexo-generator-json-content --save

    3、在根目录_config.yml里添加配置： 

      jsonContent:
    meta: false
    pages: false
    posts:
      title: true
      date: true
      path: true
      text: false
      raw: false
      content: false
      slug: false
      updated: false
      comments: false
      link: false
      permalink: false
      excerpt: false
      categories: false
      tags: true

主要涉及技术：
Java后端开发
开源爱好者、Linux

联系QQ:2960571342

很惭愧

只做了一点微小的工作
谢谢大家