Java Docket类代码示例

import springfox.documentation.spring.web.plugins.Docket; //导入依赖的package包/类
@Bean
public Docket productsApi() {
    return new Docket(DocumentationType.SWAGGER_2)
    		.globalOperationParameters(
            newArrayList(new ParameterBuilder()
                .name("Authorization")
                .description("Bearer your_token ")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .build()))
            .apiInfo(apiInfo())
            //.pathMapping("/")
            .select()
            //.apis(RequestHandlerSelectors.any())     
            .paths(PathSelectors.regex("/api.*"))
            .paths(PathSelectors.any())    
            .build();
}
 

import springfox.documentation.spring.web.plugins.Docket; //导入依赖的package包/类
@Bean
public Docket createRestApi() {
	
    return new Docket(DocumentationType.SWAGGER_2)
    		.useDefaultResponseMessages(false)
    		.additionalModels(typeResolver.resolve(ErrorInfo.class))
    		.globalResponseMessage(RequestMethod.GET, getDefaultResponseMessage())
    		.globalResponseMessage(RequestMethod.POST, getDefaultResponseMessage())
    		.globalResponseMessage(RequestMethod.PUT, getDefaultResponseMessage())
    		.globalResponseMessage(RequestMethod.DELETE, getDefaultResponseMessage())
            .directModelSubstitute(Timestamp.class, Date.class)
            .tags(new Tag("默认标签", "定义全局默认标签"),getTags())
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.plumdo.form"))
            .paths(PathSelectors.any())
            .build();
}
 

import springfox.documentation.spring.web.plugins.Docket; //导入依赖的package包/类
@Bean
public Docket thingsboardApi() {
    TypeResolver typeResolver = new TypeResolver();
    final ResolvedType jsonNodeType =
            typeResolver.resolve(
                    JsonNode.class);
    final ResolvedType stringType =
            typeResolver.resolve(
                    String.class);

      return new Docket(DocumentationType.SWAGGER_2)
              .groupName("iotp")
              .apiInfo(apiInfo())
              .alternateTypeRules(
                  new AlternateTypeRule(
                          jsonNodeType,
                          stringType))
              .select()
              .paths(apiPaths())
              .build()
              .securitySchemes(newArrayList(jwtTokenKey()))
              .securityContexts(newArrayList(securityContext()));
}
 

import springfox.documentation.spring.web.plugins.Docket; //导入依赖的package包/类
@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.regex("/documents(.*)"))
            .build()
            .globalOperationParameters(
                    Stream.of(new ParameterBuilder()
                            .name("Authorization")
                            .description("User Auth")
                            .modelRef(new ModelRef("string"))
                            .parameterType("header")
                            .required(true)
                            .build()).collect(Collectors.toList()))
            .globalOperationParameters(
                    Stream.of(new ParameterBuilder()
                            .name("ServiceAuthorization")
                            .description("Service Auth. Use it when accessing the API on App Tier level.")
                            .modelRef(new ModelRef("string"))
                            .parameterType("header")
                            .required(true)
                            .build()).collect(Collectors.toList()))
            .apiInfo(apiInfo());
}
 

import springfox.documentation.spring.web.plugins.Docket; //导入依赖的package包/类
/**
 * Controllers API doc. Note: Error controllers are excluded for brevity.
 *
 * @return {@link Docket}
 */
@Bean
public Docket api(OneOpsConfig config) {
    log.info("Configuring OneOps Secret API documentation.");
    List<Parameter> headers = singletonList(new ParameterBuilder()
            .name(config.getAuth().getHeader())
            .description("Authorization token header")
            .modelRef(new ModelRef("string"))
            .parameterType("header")
            .defaultValue("Bearer [Auth Token]")
            .required(true)
            .build());

    return new Docket(SWAGGER_2)
            .groupName("secrets")
            .ignoredParameterTypes(OneOpsUser.class)
            .globalOperationParameters(headers)
            .apiInfo(apiInfo())
            .select()
            .apis(basePackage(RootController.class.getPackage().getName()))
            .paths(regex("^(?!/error).*$")) // Ignore all '/error' handlers.
            .build();
}
 

import springfox.documentation.spring.web.plugins.Docket; //导入依赖的package包/类
@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(new ApiInfo(
                    "Smarti",
                    "the smart in assistify",
                    apiVersion,
                    null,
                    new Contact(
                            apiContactName,
                            apiContactUrl,
                            "[email protected]"
                    ),
                    "Apache 2.0",
                    "https://www.apache.org/licenses/LICENSE-2.0",
                    Collections.emptyList()
            ))
            .select()
                .apis(RequestHandlerSelectors.withClassAnnotation(Api.class))
                .paths(PathSelectors.any())
                .build()
            .securitySchemes(Arrays.asList(authToken(), basicAuth()))
            .securityContexts(Arrays.asList(publicContext(), defaultContext()))
            .ignoredParameterTypes(AuthContext.class)
            .directModelSubstitute(ObjectId.class, String.class);
}
 

import springfox.documentation.spring.web.plugins.Docket; //导入依赖的package包/类
@Bean
public Docket swaggerDocket() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(getApiInfo())
            .globalOperationParameters(Collections.singletonList(
                    new ParameterBuilder()
                            .name("Authorization")
                            .description("Provide if necessary")
                            .modelRef(new ModelRef("string"))
                            .parameterType("header")
                            .build()))
            .forCodeGeneration(true)
            .select()
            .paths(regex(DEFAULT_INCLUDE_PATTERN))
            .build();
}
 

import springfox.documentation.spring.web.plugins.Docket; //导入依赖的package包/类
@Bean
public Docket practiceApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.sdcuike.practice"))
            .paths(PathSelectors.any())
            .build()
            .pathMapping("/")
            .genericModelSubstitutes(ResponseEntity.class)
            .alternateTypeRules(
                    newRule(typeResolver.resolve(DeferredResult.class,
                            typeResolver.resolve(ResponseEntity.class, WildcardType.class)),
                            typeResolver.resolve(WildcardType.class)))
            .useDefaultResponseMessages(false)
            .globalResponseMessage(RequestMethod.GET,
                    newArrayList(new ResponseMessageBuilder()
                            .code(500)
                            .message("500 message")
                            .responseModel(new ModelRef("Error"))
                            .build()))
            .enableUrlTemplating(true)
            .tags(new Tag("Pet Service", "All apis relating to pets"));
}
 

import springfox.documentation.spring.web.plugins.Docket; //导入依赖的package包/类
@Bean
public Docket api() {
  return new Docket(DocumentationType.SWAGGER_2)//
      .select()//
      .apis(RequestHandlerSelectors.any())//
      .paths(Predicates.not(PathSelectors.regex("/error")))//
      .build()//
      .apiInfo(metadata())//
      .useDefaultResponseMessages(false)//
      .securitySchemes(new ArrayList<>(Arrays.asList(new ApiKey("Bearer %token", "Authorization", "Header"))))//
      .tags(new Tag("users", "Operations about users"))//
      .tags(new Tag("ping", "Just a ping"))//
      .genericModelSubstitutes(Optional.class);

}
 

import springfox.documentation.spring.web.plugins.Docket; //导入依赖的package包/类
@Bean
public Docket createRestApi(){
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.bootcwenao.feignserver.controller"))
            .paths(PathSelectors.any())
            .build();
}
 

import springfox.documentation.spring.web.plugins.Docket; //导入依赖的package包/类
@Bean
public Docket createRestApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .apis(RequestHandlerSelectors.basePackage("org.prcode.web"))
            .paths(PathSelectors.any())
            .build();
}
 

import springfox.documentation.spring.web.plugins.Docket; //导入依赖的package包/类
@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
            // .paths(paths())
            .build().pathMapping("/").directModelSubstitute(LocalDate.class, String.class)
            .genericModelSubstitutes(ResponseEntity.class).useDefaultResponseMessages(false)
            .globalResponseMessage(RequestMethod.GET, newArrayList(new ResponseMessageBuilder().code(500).message("500 message")
                    .responseModel(new ModelRef("Error")).build()));
}
 

import springfox.documentation.spring.web.plugins.Docket; //导入依赖的package包/类
@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.any())
            .build();
}
 

import springfox.documentation.spring.web.plugins.Docket; //导入依赖的package包/类
@Bean
public Docket createRestApi()
{
    Docket curSwaggerConfigDocket = new Docket(DocumentationType.SWAGGER_2)
            .groupName(SERVICE_GROUP_NAME_STR)                                             /** set SwaggerUI current project(Service) name */
            .useDefaultResponseMessages(false)                                             /** refuse the default response mode */
            .forCodeGeneration(true)                                                       /** set good type for API Document code */
            .select()                                                                      /** set the path where build the document */
            .apis(RequestHandlerSelectors.basePackage(SWAGGER_SCAN_BASE_PACKAGE_PATH))     /** set the path for the scanning of API,default as apis(RequestHandlerSelectors.any()) */
            .paths(PathSelectors.any())                                                    /** monitoring the api state */
            .build()
            .apiInfo(testApiInfo());
    return curSwaggerConfigDocket;
}
 

import springfox.documentation.spring.web.plugins.Docket; //导入依赖的package包/类
/**
 * Configure Spring Fox.
 *
 * @return The spring fox docket.
 */
@Bean
public Docket productApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.basePackage("com.web.web.controller"))
            .paths(any())
            .build()
            .apiInfo(metaData());
}