项目中如何集成Swagger？

第一步：在pom.xml中添加依赖

复制代码

io.springfox
springfox-swagger2
2.7.0


io.springfox
springfox-swagger-ui
2.7.0

复制代码
第二步：创建配置类

复制代码
import io.swagger.annotations.Api;
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.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2Configuration {

@Bean
public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            //  加了api注解Controller
            .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
            .paths(PathSelectors.any())
            .build();
}

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            // 接口文档头
            .title("Swagger接口文档")
            // 接口文档描述
            .description("Swagger相关接口的文档")
            // 服务器地址
            .termsOfServiceUrl("http://www.SwaggerTest.com")
            // 项目版本号
            .version("1.0")
            .build();
}

}
复制代码
第三步：创建接口

复制代码
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;

@Api(value = “TestSwaager2Controller”,description = “test接口”)
@Controller
public class TestSwaager2Controller {

@ApiOperation(value = "这是一个测试Swaager接口实例")
@ApiImplicitParams(
        {@ApiImplicitParam(name = "name", dataType = "String", required = true, paramType = "query"),
        @ApiImplicitParam(name = "desc", dataType = "String", required = true, paramType = "query")
})
@ResponseBody
@RequestMapping(value = "/swaager/swaagerTest", method = RequestMethod.POST)
public String Test(String name, String desc) {
    return "这是一个测试Swaager接口实例:{"+String.format("%s",name)+"},{"+String.format("%s",desc)+"}";
}

}
复制代码

访问：http://localhost:8080/swagger-ui.html#/

查看效果

总结：

@Api：用在请求的类上，表示对类的说明
tags=“说明该类的作用，可以在UI界面上看到的注解”
value=“该参数没什么意义，在UI界面上也看到，所以不需要配置”

@ApiOperation：用在请求的方法上，说明方法的用途、作用
value=“说明方法的用途、作用”
notes=“方法的备注说明”

@ApiImplicitParams：用在请求的方法上，表示一组参数说明
@ApiImplicitParam：用在@ApiImplicitParams注解中，指定一个请求参数的各个方面
name：参数名
value：参数的汉字说明、解释
required：参数是否必须传
paramType：参数放在哪个地方
· header --> 请求参数的获取：@RequestHeader
· query --> 请求参数的获取：@RequestParam
· path（用于restful接口）–> 请求参数的获取：@PathVariable
· body（不常用）
· form（不常用）
dataType：参数类型，默认String，其它值dataType=“Integer”
defaultValue：参数的默认值

@ApiResponses：用在请求的方法上，表示一组响应
@ApiResponse：用在@ApiResponses中，一般用于表达一个错误的响应信息
code：数字，例如400
message：信息，例如"请求参数没填好"
response：抛出异常的类

@ApiModel：用于响应类上，表示一个返回响应数据的信息
（这种一般用在post创建的时候，使用@RequestBody这样的场景，
请求参数无法使用@ApiImplicitParam注解进行描述的时候）
@ApiModelProperty：用在属性上，描述响应类的属性

参考：https://blog.csdn.net/jiangyu1013/article/details/83107255