分享swagger

目录

API文档路线:

<a href="/list">

<form method="post" ... > </form>

Swagger2

简介

The World's Most Popular Framework for APIs.

Swagger 工具

springboot 配置swagger

<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>${springfox.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>${springfox.version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-staticdocs</artifactId>
<version>${springfox.version}</version>
<scope>test</scope>
</dependency>

@Profile({"local", "dev" , "prod"})
@Configuration
@EnableSwagger2
@EnableAutoConfiguration
public class SwaggerConfig {

@Value("${app.version}")
String version;

String PROJECT_NAME = "项目名称";

@Bean
public Docket swaggerSpringfoxDocket() {
Docket swaggerSpringMvcPlugin = new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.groupName("crm-analysis-task")
.consumes(Collections.singleton(MediaType.APPLICATION_JSON_UTF8_VALUE))
.produces(Collections.singleton(MediaType.APPLICATION_JSON_UTF8_VALUE))
.genericModelSubstitutes(ResponseEntity.class)
.select()
.paths(PathSelectors.regex(".*")) // and by paths
.build().securitySchemes(apiKeys())
.securityContexts(securityContext());
return swaggerSpringMvcPlugin;
}

private ApiInfo apiInfo(){
ApiInfo apiInfo = new ApiInfo(
PROJECT_NAME ,
"",
version,
"http://test.api.xxx.com",
new Contact("LI","", "myemail@xxx.com"),
"License",
"/License");
return apiInfo;
}

private List<SecurityContext> securityContext() {
List list = Lists.newArrayList();
list.add(SecurityContext.builder()
.securityReferences(thirdClient1())
.forPaths(PathSelectors.regex("/.*?"))
.build());
return list;
}

private List<ApiKey> apiKeys() {
List<ApiKey> list = Lists.newArrayList();
list.add(new ApiKey("thirdClient1_Key", "api_key", "header"));
list.add(new ApiKey("thirdClient2_Key", "api_key", "header"));
return list;
}

List<SecurityReference> thirdClient1() {
AuthorizationScope authorizationScope = new AuthorizationScope("thirdClient1", "access /app/*");
AuthorizationScope[] authorizationScopes = new AuthorizationScope[]{authorizationScope};
return Lists.newArrayList(new SecurityReference("thirdClient1_Key", authorizationScopes));
}

SecurityConfiguration security() {
return new SecurityConfiguration(
"test-app-client-id",
"test-app-client-secret",
"test-app-realm",
"test-app",
"ISDFLISDFJL",
ApiKeyVehicle.HEADER,
"api_key",
"," );
}

@Bean
UiConfiguration uiConfig() {
return new UiConfiguration(
"validatorUrl",// url
"none",       // docExpansion          => none | list
"alpha",      // apiSorter             => alpha
"schema",     // defaultModelRendering => schema
UiConfiguration.Constants.DEFAULT_SUBMIT_METHODS,
true,        // enableJsonEditor      => true | false
true);        // showRequestHeaders    => true | false
}

}

新路线总结:

代码

MORE