SpringBoot集成Swagger，适用于新手入门

Swagger

如果有不对或者不够好的地方大家也可以指出来让我们一起改正错误

学习目标：

• 了解Swagger的作用和概念
• 了解后端分离
• 在SpringBoot中集成Swagger

Swagger简介

前后端分离

Vue + SpringBoot

后端时代：前端只用管理静态页面；html==>后端。模板引擎 JSP=> 后端是主力

前后端分离式时代

• 后端：后端控制层，服务层，数据访问层 【后端团队】
• 前端：前端控制层，视图层 【前端团队】
  • 伪造后端数据，json。已经存在了，不需要后端，前端工程依旧能够跑起来
• 前后端如何交互？==> API
• 前后端相对独立，松耦合；
• 前后端甚至可以部署在不同的服务器上；

产生一个问题：

• 前后端集成联调，前端人员和后端人员无法做到“及时协商，尽早解决”，最终导致问题集中爆发；

解决方案：

• 首先指定schema[计划的提纲]，实时更新最新API，降低集成的风险；
• 早些年：制定word计划文档；
• 前后端分离：
  • 前端测试后端接口：postman
  • 后端提供接口，需要实时更新最新的消息及改动！

SWagger

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

官网：https://swagger.io/

在项目使用Swagger需要springbox；

• swagger2
• ui

SpringBoot集成Swagger

1. 新建一个SpringBoot—web项目

2. 导入相关依赖

   <!--Swagger-->
   <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:8080/swagger-ui.html

   

配置Swagger

Swagger的bean实例 Docket；

@Configuration
@EnableSwagger2     //开启Swagger2
public class SwaggerConfig {

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

    //配置Swagger信息=apiInfo
    private ApiInfo apiInfo(){
        Contact contact = new Contact("灰灰", "https://www.kuangstudy.com/", "@qq.com");

        return new ApiInfo("灰灰的SwaggerAPI文档",
                "好好学习，天天向上",
                "1.0",
                "http://localhost:8081/hello",
                contact,
                "Apache 2.0",
                "http://www.apache.org/licenses/LICENSE-2.0",
                new ArrayList());
    }
}

SWagger配置扫描接口

Docket.select()

//配置了Swagger的Docket的bean实例
@Bean
public Docket docket(){
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            //RequestHandlerSelectors，配置扫描接口的方式
            //basePackage：指定要扫描的包
            //any():扫描全部
            //none():不扫描
            //withClassAnnotation：扫描类上的注解，参数是一个注解的反射对象
            //withMethodAnnotation：扫描方法上的注解
            .apis(RequestHandlerSelectors.basePackage("com.hui.swagger.controller"))
            //paths()：过滤什么路径
            .paths(PathSelectors.ant("/hui/**"))
            .build();
}

配置是否启动Swagger

	//配置了Swagger的Docket的bean实例
    @Bean
    public Docket docket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .enable(false) //enable是否启动Swagger，如果未False，则Swagger不能在浏览器中访问
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.hui.swagger.controller"))
                //.paths(PathSelectors.ant("/hui/**"))
                .build();
    }

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

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

	//配置了Swagger的Docket的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，如果未False，则Swagger不能在浏览器中访问
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.hui.swagger.controller"))
                //.paths(PathSelectors.ant("/hui/**"))
                .build();
    }

配置Api文档的分组

.groupName("灰灰")

如何配置多个分组，多个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");
    }

实体类配置

package com.hui.swagger.pojo;
import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;
//@Api("注释")
@ApiModel("用户实体类")
public class User {
    @ApiModelProperty("用户名")
    public String username;
    @ApiModelProperty("密码")
    public String password;
}

controller

package com.hui.swagger.controller;
import com.hui.swagger.pojo.User;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class HelloController {
    @GetMapping(value = "/hello")
    public String hello(){
        return "hello";
    }
    //只要我们接口中，返回值中存在实体类，他就会被扫描到Swagger中
    @PostMapping(value = "/user")
    public User user(){
        return new User();
    }
    //Operation接口，不是放在类上的，是放在方法上的
    @ApiOperation("hello控制类")
    @GetMapping(value = "/hello2")
    public String hello2(@ApiParam("用户名")String username){
        return "hello"+username;
    }
    @ApiOperation("Post测试类")
    @GetMapping(value = "/postt")
    public User postt(@ApiParam("用户类")User user){
        int i = 5/0;	//500错误
        return user;
    }
}

总结：

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

Swagger是一个优秀的工具，几乎所有大公司都有使用它

【注意点】在正式发布的时候，关闭Swagger！！！出于安全考虑。而且节省运行的内存

最后想学习的伙伴可以关注我随便来个免费的赞鼓励一下，之后我学习了什么好一点的技术都会分享到csdn，都是通俗易懂，然后让我们一起努力学习更多的新技术，在这里推荐一位b站上讲得超好的一位讲师 狂神说Java，我也算是他的粉丝吧，这可是一位大佬，之后出的新技术我学完都会把笔记和心得分享在这里，谢谢大家观看。