Swagger

文章目录

• Swagger

swagger简介

号称世界上最流行的API框架
RestFul Api 文档在线自动生成工具=> Api 文档与Api定义同步更新
直接运行，可以在线测试Api接口
支持多种语言（java php）

官网: https://swagger.io/

在项目中使用swagger需要Springfox

• Swagger2
• Swagger-UI

SpringBoot集成Swagger

1. 新建一个springboot 的web项目
2. 导入相关依赖 注意： 依赖版本导入2.9.2 ，如果是3.0.0 就访问不了 http://localhost/swagger-ui.html

<!--        导入依赖-->
        <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>

3.编写一个hello工程

4.配置Swagger ===> Config

@Configuration
@EnableSwagger2  //开启swagger2
public class SwaggerConfig {
    
}

5.测试运行
访问 http://localhost/swagger-ui.html

配置Swagger

swagger的Bean实例 Docket；

 //配置Swagger的 bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo());
    }

    //配置Swagger文档信息
    private ApiInfo apiInfo(){

        //作者信息
        Contact contact = new Contact("姚文宇", "https://blog.csdn.net/yao_wen_yu", "[e-mail]");

        return  new ApiInfo(
                "Yaowenyu Swagger 接口API",
                "没有学不会的技术",
                "v2.0",
                "https://blog.csdn.net/yao_wen_yu",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    }

Swagger配置扫描接口

Docket.seleect ()

 @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //RequestHandlerSelectors  配置接口扫描的方式
                //.basePackage指定扫描的包
                //.any 扫描所有
                //.none 都不扫描
                //.withClassAnnotation 扫描类上的注解，参数是一个注解的反射对象
                //.withMethodAnnotation 扫描方法上的注解
                .apis(RequestHandlerSelectors.basePackage("com.yao.swagger.controller"))
                //paths 过滤路径
                .paths(PathSelectors.ant("/yao/**"))
                .build();
    }

配置是否启动 Swagger

//配置Swagger的 bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)

                .apiInfo(apiInfo())
                .enable(false)  //enable 是否启动swagger
                .select()
                //RequestHandlerSelectors  配置接口扫描的方式
                //.basePackage指定扫描的包
                //.any 扫描所有
                //.none 都不扫描
                //.withClassAnnotation 扫描类上的注解，参数是一个注解的反射对象
                //.withMethodAnnotation 扫描方法上的注解
//                .apis(RequestHandlerSelectors.basePackage("com.yao.swagger.controller"))
//                //paths 过滤路径
//                .paths(PathSelectors.ant("/yao/**"))
                .build();
    }

只希望Swagger在生产环境中使用，在发布环境不使用？

• 判断是不是生产环境 flag = false
• 注入 enable ( true)

 //配置Swagger的 bean实例
    @Bean
    public Docket docket(Environment environment){

        //设置要显示的swagger环境
        Profiles profiles = Profiles.of("dev");

        //通过environment.acceptsProfiles判断是否处在自己设定的环境
        boolean flag = environment.acceptsProfiles(profiles);

        return new Docket(DocumentationType.SWAGGER_2)

                .apiInfo(apiInfo())
                .enable(flag)  //enable 是否启动swagger
                .select()
                //RequestHandlerSelectors  配置接口扫描的方式
                //.basePackage指定扫描的包
                //.any 扫描所有
                //.none 都不扫描
                //.withClassAnnotation 扫描类上的注解，参数是一个注解的反射对象
                //.withMethodAnnotation 扫描方法上的注解
//                .apis(RequestHandlerSelectors.basePackage("com.yao.swagger.controller"))
//                //paths 过滤路径
//                .paths(PathSelectors.ant("/yao/**"))
                .build();
    }

配置API 文档的分组

.groupName("yaowenyu")

如何配置多个分组

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

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

    @Bean
    public Docket docket4(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("C");
    }

实体类配置

实体类

@ApiModel("用户实体类注释")
public class User {

    @ApiModelProperty("用户名")
    public String username;
    @ApiModelProperty("密码")
    public String password;
}

controller

package com.yao.swagger.controller;

import com.yao.swagger.pojo.User;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;


@RestController
public class HelloController {

    @GetMapping("/hello")
    public String Hello(){
     return "hello";
    }

    //只要我们的接口中，返回值中存在实体类，他就会被扫描到
    @PostMapping("/user")
    public User user(){
        return new User();
    }
    //@ApiOperation() 使用在方法上面 ，而不是类上面
    @ApiOperation("Hello 控制类")
    @GetMapping("/hello2")
    public String hello(@ApiParam("用户名") String username){
        return "hello"+username;
    }

    @ApiOperation("post 测试")
    @PostMapping("/postt")
    public User hello(@ApiParam("用户名") User user){
        return user;
    }
}

总结:

1. 我们可以通过Swagger给一些比较难理解的属性或接口增加注释信息
2. 接口文档实时更新
3. 可以在线测试

Swagger是一个优秀的工具。