springfox.documentation.builders.ApiInfoBuilder Java Examples

/**
 * 动态产生Docket分组信息
 *
 * @return
 */
@Autowired
public void dynamicConfiguration() {
    ConfigurableApplicationContext context = (ConfigurableApplicationContext) applicationContext;
    DefaultListableBeanFactory beanFactory = (DefaultListableBeanFactory) context.getBeanFactory();

    String systemName = "Microservice PaaS";
    ApiInfoBuilder apiInfoBuilder = new ApiInfoBuilder()
            .description("mPaas前端后端对应接口")
            .version("1.0.1")
            .license("Code Farmer Framework(iByte) Org.");

    Map<String, ModuleMappingInfo> moduleInfo = mappingHelper.getMappingInfos();
    for (Map.Entry<String, ModuleMappingInfo> entry : moduleInfo.entrySet()) {
        beanFactory.registerSingleton(entry.getKey(), new Docket(DocumentationType.SWAGGER_2)
                .groupName(entry.getKey())
                .apiInfo(apiInfoBuilder.title(systemName + NamingConstant.DOT + entry.getKey()).build())
                .select()
                .apis(genSubPackage(entry.getKey()))
                .paths(Predicates.or(PathSelectors.ant(NamingConstant.PATH_PREFIX_DATA + "/**"),
                        PathSelectors.ant(NamingConstant.PATH_PREFIX_API + "/**")))
                .build());
    }
}
 

/**
	 * api文档的详细信息函数,注意这里的注解引用的是哪个
	 *
	 * @return
	 */
	private ApiInfo apiInfo() {
		return new ApiInfoBuilder()
				// //大标题
				.title("Jeecg-Boot 后台服务API接口文档")
				// 版本号
				.version("1.0")
//				.termsOfServiceUrl("NO terms of service")
				// 描述
				.description("后台API接口")
				// 作者
				.contact("JEECG团队")
                .license("The Apache License, Version 2.0")
                .licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
				.build();
	}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("SwaggerUI演示")
            .description("mall-tiny")
            .contact("macro")
            .version("1.0")
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("SwaggerUI演示")
            .description("Demo模块")
            .contact("macro")
            .version("1.0")
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("mall前台系统")
            .description("mall前台系统")
            .contact("macro")
            .version("1.0")
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("his-cloud-service-pms")
            .description("基于restful的HIS接口")
            .contact("neu")
            .version("1.0")
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("user-service-2 通用接口")
            .description("user-service-2 通用接口")
            .version("0.0.1")
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("Code for Social Good Web Application")
            .description("Code for Social Good is a global volunteering platform that provides nonprofit organizations and open source projects with free technical resources.")
            .termsOfServiceUrl("#")
            .contact(new Contact("Code for Social Good", "http://code4socialgood.org/", "[email protected]"))
            .license("Licence")
            .licenseUrl("#")
            .version("1.0")
            .build();
}
 

ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title("OpenAPI Petstore")
        .description("This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\")
        .license("Apache-2.0")
        .licenseUrl("https://www.apache.org/licenses/LICENSE-2.0.html")
        .termsOfServiceUrl("")
        .version("1.0.0")
        .contact(new Contact("","", ""))
        .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("硕果云")
            .description("https://gitee.com/wells2333/spring-microservice-exam")
            .termsOfServiceUrl("https://gitee.com/wells2333/spring-microservice-exam")
            .contact(new Contact("tangyi", "https://gitee.com/wells2333/spring-microservice-exam", "[email protected]"))
            .version("3.7.0")
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("wc-client-admin")
            .description("接口文档说明")
            .contact(new Contact("浅然", "", "[email protected]"))
            .version("2.0")
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("脚手架接口文档")
            .description("提供一站式sso解决方案")
            .contact("shf")
            .termsOfServiceUrl("http://localhost:8080/")
            .version("1.0")
            .build();

}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("Guns Doc")
            .description("Guns Api文档")
            .termsOfServiceUrl("http://git.oschina.net/naan1993/guns")
            .contact("stylefeng")
            .version("2.0")
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("yyblog项目api接口文档")
            .description("部分接口展示")
            .contact(new Contact("小卖铺的老爷爷", "http://www.laoyeye.net/", "allan_zhuo#163.com"))
            .version("1.0")
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("Spring Boot中使用Swagger2构建RESTful APIs")
            .description("更多Spring Boot API")
            .termsOfServiceUrl("https://github.com/zhoutaoo/SpringCloud")
            .version("2.0")
            .build();
}
 

@Bean
public Docket docket() {
	return new Docket(DocumentationType.SWAGGER_2).groupName("认证中心swagger接口文档")
			.apiInfo(new ApiInfoBuilder().title("认证中心swagger接口文档")
					.contact(new Contact("allen", "", "[email protected]")).version("1.0").build())
			.select().paths(PathSelectors.any()).build();
}
 

/**
 * 创建Swagger页面 信息
 * @return
 */
private ApiInfo apiInfo() {
    return new ApiInfoBuilder().
            title(title).
            contact(contact).
            version(version).
            license(license).
            licenseUrl(licenseUrl).
            termsOfServiceUrl(termsOfServiceUrl).
            description(description)
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            // 文档标题
            .title("这里是Swagger文档标题")
            // 文档描述
            .description("这里是文档描述")
            .termsOfServiceUrl("https://www.dusty.vip")
            .version("v1.0")//定义版本号
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("mall搜索系统")
            .description("mall搜索模块")
            .contact("macro")
            .version("1.0")
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
        .title(swaggerProperties.getApiInfo().getTitle())
        .description(swaggerProperties.getApiInfo().getDescription())
        .license(swaggerProperties.getApiInfo().getLicense())
        .licenseUrl(swaggerProperties.getApiInfo().getLicenseUrl())
        .termsOfServiceUrl(swaggerProperties.getApiInfo().getTermsOfServiceUrl())
        .version(swaggerProperties.getApiInfo().getVersion())
        .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title(openSwaggerProperties.getTitle())
            .description(openSwaggerProperties.getDescription())
            .version("1.0")
            .build();
}
 

@Bean
ApiInfo apiInfo(AppProperties appProperties, VersionService versionService) {
    return new ApiInfoBuilder()
            .title(appProperties.getTitle())
            .description(appProperties.getDescription())
            .version(versionService.getApplicationVersion().getImplementationVersion())
            .contact(new Contact(
                    appProperties.getContact().getName(),
                    appProperties.getContact().getUrl(),
                    appProperties.getContact().getEmail()
            ))
            .license(appProperties.getLicense().getName())
            .licenseUrl(appProperties.getLicense().getUrl())
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            // 标题
            .title("springboot 利用 swagger 构建 API 文档")
            // Api 文档描述
            .description("简单优雅的 restful 风格，https://blog.csdn.net/turodog/")

            .termsOfServiceUrl("https://blog.csdn.net/turodog/")
            // 文档作者信息
            .contact(new Contact("陈志远", "https://github.com/turoDog", "[email protected]"))
            // 文档版本
            .version("1.0")
            .build();
}
 

/**
 * @param
 * @return springfox.documentation.service.ApiInfo
 * @Title: 构建API基本信息
 * @methodName: buildApiInfo
 * @Description:
 * @author: 王延飞
 * @date: 2017-12-11  8:44
 */
private ApiInfo buildApiInfo() {

    return new ApiInfoBuilder()
            .title("用户信息API文档")
            .description("这里除了查看接口功能外，还提供了调试测试功能")
            .contact("王延飞")
            .version("1.0")
            .build();

}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("SwaggerUI演示")
            .description("mall-tiny")
            .contact("macro")
            .version("1.0")
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("his-cloud-service-pms")
            .description("基于restful的HIS接口")
            .contact("neu")
            .version("1.0")
            .build();
}
 

/**
 * 说明配置
 * @author Frodez
 * @date 2019-01-06
 */
private void infoConfig(Docket docket) {
	ApiInfoBuilder infoBuilder = new ApiInfoBuilder();
	infoBuilder.title(swagger.getTitle());
	infoBuilder.description(swagger.getDescription());
	Contact contact = new Contact(swagger.getAuthor(), swagger.getDocUrl(), swagger.getEmail());
	infoBuilder.contact(contact);
	infoBuilder.version(swagger.getAppVersion());
	infoBuilder.license(swagger.getLicense());
	infoBuilder.licenseUrl(swagger.getLicenseUrl());
	docket.apiInfo(infoBuilder.build());
}
 

private ApiInfo wxApiInfo() {
    return new ApiInfoBuilder()
            .title("litemall-wx API")
            .description("litemall小商场API")
            .termsOfServiceUrl("https://github.com/linlinjava/litemall")
            .contact("https://github.com/linlinjava/litemall")
            .version("1.0")
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("订单服务")
            .description("订单管理")
            .termsOfServiceUrl("website")
            .contact(new Contact("name", "url", "email"))
            .version("v1.0")
            .build();
}
 

private ApiInfo apiInfo() {
    return new ApiInfoBuilder()
            .title("Quark BBS 接口文档")
            .contact("LHR")
            .version("1.0")
            .build();
}