Swagger

号称世界上最流行的Api框架;

RestFul Api 文档在线自动生成工具=>Api文档与API定义同步更新

直接运行，可以在线测试API接口；（就是cntroller）

支持多种语言.

1、简介

官网：

Swagger是一个规范和完整的框架，用于生成、描述、调用和RESTful风格的Web服务。通俗的来讲，Swagger 就是将项目中所有（想要暴露的）接口展现在页面上，并且可以进行接口调用和测试的服务。

了解前后端分离

在SpringBoot中集成Swagger

2、使用

在项目中使用Swagger需要springbo;

suagger2

ui

3、SpringBoot集成Swagger

1、创建一个SpringBoot = web项目

2、导入相关依赖

<!--导入swagger依赖-->
<!-- 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、编写hello Swageer功能

        略

4、配置Swagger---》config

@Configuration  //声明类为一个配置类,用于取代bean.xml配置文件注册bean对象。
@EnableSwagger2 //开启swagger
public class SwaggerConfig {
    //创建swagger bean
    //配置了swagger的Docker的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
        //swagger信息
                .apiInfo(apiInfo());
    }
}

 5、http://localhost:8081/swagger-ui.html#/   //端口号自己看

 配置Swagger（可默认不配置,没啥用）

//配置swagger信息===apiInfo
//swager文档信息
private ApiInfo apiInfo(){
    //作者信息
    Contact contact = new Contact("jinlei", "http://localhost:8080/swagger-ui.html#/", "888888@qq.com");
    //
    return new ApiInfo(
            "jinlei的SwaggerApi",
            "swagerrApi 这是描述",
            "1.0",
            "https://www.baidu.com/",
            contact,
            "Apache 2.0",
            "http://www.apache.org/licenses/LICENSE-2.0",
            new ArrayList());

}

Swagger配置扫描接口、配置是否启动swagger、

希望我的Swagger在生产环境使用，在发布的时候不使用

判断是不是生产环境 flag = false

注入enable(flag)

配置Api文档的分组、配置多个分组

@Configuration  //声明类为一个配置类,用于取代bean.xml配置文件注册bean对象。
@EnableSwagger2 //开启swagger
public class SwaggerConfig {

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

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


    //创建swagger bean
    //配置了swagger的Docker的bean实例
    @Bean
    public Docket docket(Environment environment){

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

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

        return new Docket(DocumentationType.SWAGGER_2)
                //swagger信息
                .apiInfo(apiInfo())
                //配置分组
                .groupName("jLei")
                //是否启动swagger,false为不启动
                .enable(flag)
                .select()
                //RequestHandlerSelectors，配置要扫描接口的方式
                //basePackage,指定要扫描的包
                //any,扫描全部
                //none,都不扫描
                //withClassAnnotation,扫描类上的注解,参数是一个注解的反射对象
                //withMethodAnnotation,扫描方法上的注解
                .apis(RequestHandlerSelectors.basePackage("com.tx.controller"))
                .build();
    }

    //配置swagger信息===apiInfo
    //swager文档信息
    private ApiInfo apiInfo(){
        //作者信息
        Contact contact = new Contact("XXX", "http://localhost:8080/swagger-ui.html#/", "88888888@qq.com");
        //
        return new ApiInfo(
                "888的SwaggerApi",
                "swagerrApi 这是描述",
                "1.0",
                "https://www.baidu.com/",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());

    }
}

 

总：我们可以通过swagger给一些比较难理解的属性或者接口，增加注释信息

@ApiModel("用户实体类") //给swagger文档加注释
public class User {

    @ApiModelProperty("用户Id")
    public Integer userId;
    @ApiModelProperty("用户名")
    public String userName;
    @ApiModelProperty("密码")
    public String userPassword;

 

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

}

接口文档实时更新

可以在线测试

注意：正式发布项目时，关闭Swagger。