Java DocumentationType类代码示例

import springfox.documentation.spi.DocumentationType; //导入依赖的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.spi.DocumentationType; //导入依赖的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.spi.DocumentationType; //导入依赖的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.spi.DocumentationType; //导入依赖的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.spi.DocumentationType; //导入依赖的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.spi.DocumentationType; //导入依赖的package包/类
@Bean
public Docket createRestApi() {
	
    return new Docket(DocumentationType.SWAGGER_2)
    		.useDefaultResponseMessages(false)
    		.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.spi.DocumentationType; //导入依赖的package包/类
@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            //                .apis(RequestHandlerSelectors.any()) // show all service, including spring-boot default.
            .apis(RequestHandlerSelectors.basePackage("com.mkdika.spring5restapi.web.api")) // show specific class path only                 
            .paths(PathSelectors.any())
            .build()
            .apiInfo(metaInfo());
}
 

import springfox.documentation.spi.DocumentationType; //导入依赖的package包/类
/**
 * Swagger Springfox configuration.
 *
 * @param jHipsterProperties the properties of the application
 * @return the Swagger Springfox configuration
 */
@Bean
public Docket swaggerSpringfoxDocket(JHipsterProperties jHipsterProperties) {
    log.debug("Starting Swagger");
    StopWatch watch = new StopWatch();
    watch.start();
    Contact contact = new Contact(
        jHipsterProperties.getSwagger().getContactName(),
        jHipsterProperties.getSwagger().getContactUrl(),
        jHipsterProperties.getSwagger().getContactEmail());

    ApiInfo apiInfo = new ApiInfo(
        jHipsterProperties.getSwagger().getTitle(),
        jHipsterProperties.getSwagger().getDescription(),
        jHipsterProperties.getSwagger().getVersion(),
        jHipsterProperties.getSwagger().getTermsOfServiceUrl(),
        contact,
        jHipsterProperties.getSwagger().getLicense(),
        jHipsterProperties.getSwagger().getLicenseUrl());

    Docket docket = new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo)
        .forCodeGeneration(true)
        .genericModelSubstitutes(ResponseEntity.class)
        .ignoredParameterTypes(Pageable.class)
        .ignoredParameterTypes(java.sql.Date.class)
        .directModelSubstitute(java.time.LocalDate.class, java.sql.Date.class)
        .directModelSubstitute(java.time.ZonedDateTime.class, Date.class)
        .directModelSubstitute(java.time.LocalDateTime.class, Date.class)
        .select()
        .paths(regex(DEFAULT_INCLUDE_PATTERN))
        .build();
    watch.stop();
    log.debug("Started Swagger in {} ms", watch.getTotalTimeMillis());
    return docket;
}
 

import springfox.documentation.spi.DocumentationType; //导入依赖的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.spi.DocumentationType; //导入依赖的package包/类
@Bean
public Docket piApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .paths(regex("/api/cpg.*"))
            .build();
}
 

import springfox.documentation.spi.DocumentationType; //导入依赖的package包/类
@Bean
public Docket api() {
    return new Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.ant("/rest/**"))
            .build()
            .apiInfo(apiInfo());
}
 

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

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

import springfox.documentation.spi.DocumentationType; //导入依赖的package包/类
@Bean
public Docket createRestApi(Swagger2Properties swagger2Properties) {

    return new Docket(DocumentationType.SWAGGER_2)
        .apiInfo(apiInfo(swagger2Properties))
        .select()
        .paths(paths(swagger2Properties))
        .apis(apis(swagger2Properties))
        .build()
        .globalOperationParameters(globalOperationParameters(swagger2Properties))
        ;
}
 

import springfox.documentation.spi.DocumentationType; //导入依赖的package包/类
@Bean
public Docket piApi() {
    return new Docket(DocumentationType.SWAGGER_2)
            .apiInfo(apiInfo())
            .select()
            .paths(regex("/api/chl.*"))
            .build();
}