Swagger 笔记

Swagger 笔记 Swagger 风格

• springfox-swagger-ui
• swagger-bootstrap-ui

maven

两个风格都需要引入

    io.springfox
    springfox-swagger2
    2.9.2

如果是 springfox-swagger-ui：

    io.springfox
    springfox-swagger-ui
    2.9.2

如果是 swagger-bootstrap-ui

	com.github.xiaoymin
	swagger-bootstrap-ui
	1.9.6

注解

• @Api

一般用于 @Controller 上：

@Api(tags = "")

• @ApiOperation

一般用于 @Controller 类的注解上：

@ApiOperation(value = "")

Spring

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {
 
    
    public List globalOperationParameters() {
        List params = new ArrayList();
        Parameter parameter = new ParameterBuilder()
                .name("X-Token")
                .description("JSON Web Token")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(false)
                .build();
        params.add(parameter);
        return params;
    }
 
    @Bean
    public Docket Api() {
        ApiInfo apiInfo = new ApiInfoBuilder()
                .title("标题")
                .description("本文档为前后端开发人员提供参考")
                .termsOfServiceUrl("urn:tos")
                .license("Apache 2.0")
                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0")
                .version("1.0") // 版本
                .contact(new Contact("JCB", "https://github.com/JiangChunbo", "[email protected]")) // 联系方式
                .build();
        return new Docket(documentationType.SWAGGER_2)
                .groupName("系统 API")
                .apiInfo(apiInfo)
                .select()
                .apis(RequestHandlerSelectors.withMethodAnnotation(ApiOperation.class)) // 根据方法注解筛选
                // .apis(RequestHandlerSelectors.withClassAnnotation(Api.class)) // 根据类注解筛选
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(globalOperationParameters());
    }
}

Docket 方法

方法名描述groupName分组名，默认值 default

ApiInfo 方法

方法名描述title(String)标题description(String)描述termOfServiceUrl(String)业务组 urllicense(String)证书licenseUrl(String)证书 URLversion(String)版本concat(Contact)联系人，包括 name、url、email