7、集成Swagger实现API自动生成

### 1、引入坐标

```
<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>
```

这里只引入了本章节的关键坐标信息

完整的pom.xml文件请查看项目的源代码。

### 2、创建入口启动文件

~~~java
@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class,args);
    }
}
~~~

### 3、swagger配置文件

注意一下这里的 com.mmno.swagger.controller 包名，根据你项目的实际情况，不要配置错了。

另外 http://localhost:8080/ 这个地址也要根据实际的情况修改。

~~~java
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {
    private static Logger log = LoggerFactory.getLogger(SwaggerConfig.class);
    @Bean
    public Docket createRestApi() {
        log.info("进入到swagger的配置中");
        return new Docket(DocumentationType.SWAGGER_2)
                // 指定构建api文档的详细信息的方法：apiInfo()
                .apiInfo(apiInfo())
                .groupName("分组名称")
                .select()
                // 指定要生成api接口的包路径，这里把controller作为包路径，生成controller中的所有接口
                .apis(RequestHandlerSelectors.basePackage("com.mmno.swagger.controller"))
                .paths(PathSelectors.any())
                .build();
    }

/**
     * 构建api文档的详细信息
     * @return
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                // 设置页面标题
                .title("Spring Boot集成Swagger2接口总览")
                // 设置接口描述
                .description("Swagger接口")
                // 设置联系方式
                .contact(new Contact("测试swagger","http://localhost:8080/",""))
                // 设置版本
                .version("1.0")
                // 构建
                .build();
    }

}
~~~

### 4、创建一个控制器

这里只是重点用注释的方式对接口进行描述，没有有方法体内写具体的业务实现。

@Api
@ApiOperation
@ApiImplicitParams
@ApiImplicitParam

~~~java
@Api("用户操作接口")
@RestController
public class TestController {

@GetMapping("/hello")
    @ApiOperation(value = "helloworld",notes = "你好")
    public String hello(){
        return "hello";
    }

@GetMapping("/getList")
    @ApiOperation(value = "获取列表信息",notes = "没啥留言的")
    public Object getList(){
        return null;
    }

@PostMapping(value = "/updateOne")
    @ApiOperation(value = "添加",notes = "没啥留言的")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "id",required = true,paramType = "query",dataType = "String",value = "编号"),
            @ApiImplicitParam(name = "password",required = true,paramType = "query",dataType = "String",value = "密码"),
    })
    public Object updateOne(String id,String password){
       return null;
    }
}
~~~

### 查看效果

浏览器访问  http://localhost:8080/swagger-ui.html 查看效果。

![image-20221102104742940](/media/202301/image-20221102104742940.png)