Springboot集成Swagger2

Swagger2使用说明

1、swagger2作用

​ 接口管理工具，是一套规范项目接口，帮接口自动生成接口文档。方便各个系统之间的调用，方便各方系统。

​ 提供ui界面，方便开发人员进行测试，节省开发人员大部分的时间。

---

2、spring 集成swagger2

2.1 引用 springfox 包

		<!-- swagger的依赖-->
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger-ui</artifactId>
			<version>2.7.0</version>
		</dependency>
		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.7.0</version>
		</dependency>

2.2 涉及到的实体类以及controller

​ Customer.java 实体类

@Data
@AllArgsConstructor
@NoArgsConstructor
@ToString
public class Customer {
   
    private String name;
    private String password;

}

​ CustomerController.java Customer相关的Controller类

@RestController
@Slf4j
public class CustomerController {
   
    @GetMapping("/login")
    public String login(String name,String password ){
   
        return "Hello " + name +"|||  " + password;
    }
}

2.3 启动类中添加注解

---

​ 启动类中添加注解@EnableSwagger2 表明整个SpringBoot工程中启用Swagger2，此时就已经可以在浏览器中输入http://localhost:8080/swagger-ui.html访问简易的页面（具体的需要进行配置类的定义）

​ SpringApplication.java中

@SpringBootApplication
@EnableSwagger2
public class SwaggerApplication {
   

	public static void main(String[] args) {
   
		SpringApplication.run(SwaggerApplication.class, args);
	}

}

---

​ swagger-ui页面展示

​ 图片可以看到很多地方都是默认的英文，这时候需要添加配置类，让接口说明看的很通俗、直观

3、Swagger2的配置

3.1 编写Swagger2 配置类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.service.ApiInfo;
import springfox.documentation