下面列出了org.springframework.boot.autoconfigure.SpringBootApplication#springfox.documentation.service.Contact 实例代码,或者点击链接到github查看源代码,也可以在右侧发表评论。
@Bean
public Docket apiDocket() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(new ApiInfoBuilder()
.title("Certificate Generator")
.description("Certificate Generator for Testing Purposes of PSD2 Sandbox Environment")
.contact(new Contact(
"adorsys GmbH & Co. KG",
"https://adorsys.de",
"[email protected]"))
.version(buildProperties.getVersion() + " " + buildProperties.get("build.number"))
.build())
.groupName("Certificate Generator API")
.select()
.apis(RequestHandlerSelectors.basePackage("de.adorsys.psd2.sandbox.certificate"))
.paths(PathSelectors.any())
.build();
}
/**
* 添加摘要信息(Docket)
*/
@Bean
public Docket controllerApi() {
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(new ApiInfoBuilder()
.title("API实时接口文档")
.description("用于实时查看、测试API")
.contact(new Contact("huanzi-qch", "https://www.cnblogs.com/huanzi-qch/", ""))
.version("版本号:1.0")
.build())
.select()
//API基础扫描路径
.apis(RequestHandlerSelectors.basePackage("cn.huanzi.qch.springbootswagger2.controller"))
.paths(PathSelectors.any())
.build();
}
/**
* Will exposed on $HOST:$PORT/swagger-ui.html
*
* @return
*/
@Bean
public Docket apiDocumentation() {
return new Docket(SWAGGER_2)
.select()
.apis(basePackage("se.magnus.microservices.composite.product"))
.paths(PathSelectors.any())
.build()
.globalResponseMessage(POST, emptyList())
.globalResponseMessage(GET, emptyList())
.globalResponseMessage(DELETE, emptyList())
.apiInfo(new ApiInfo(
apiTitle,
apiDescription,
apiVersion,
apiTermsOfServiceUrl,
new Contact(apiContactName, apiContactUrl, apiContactEmail),
apiLicense,
apiLicenseUrl,
emptyList()
));
}
/**
* Will exposed on $HOST:$PORT/swagger-ui.html
*
* @return
*/
@Bean
public Docket apiDocumentation() {
return new Docket(SWAGGER_2)
.select()
.apis(basePackage("se.magnus.microservices.composite.product"))
.paths(PathSelectors.any())
.build()
.globalResponseMessage(POST, emptyList())
.globalResponseMessage(GET, emptyList())
.globalResponseMessage(DELETE, emptyList())
.apiInfo(new ApiInfo(
apiTitle,
apiDescription,
apiVersion,
apiTermsOfServiceUrl,
new Contact(apiContactName, apiContactUrl, apiContactEmail),
apiLicense,
apiLicenseUrl,
emptyList()
));
}
/**
* Will exposed on $HOST:$PORT/swagger-ui.html
*
* @return
*/
@Bean
public Docket apiDocumentation() {
return new Docket(SWAGGER_2)
.select()
.apis(basePackage("se.magnus.microservices.composite.product"))
.paths(PathSelectors.any())
.build()
.globalResponseMessage(POST, emptyList())
.globalResponseMessage(GET, emptyList())
.globalResponseMessage(DELETE, emptyList())
.apiInfo(new ApiInfo(
apiTitle,
apiDescription,
apiVersion,
apiTermsOfServiceUrl,
new Contact(apiContactName, apiContactUrl, apiContactEmail),
apiLicense,
apiLicenseUrl,
emptyList()
));
}
/**
* Will exposed on $HOST:$PORT/swagger-ui.html
*
* @return
*/
@Bean
public Docket apiDocumentation() {
return new Docket(SWAGGER_2)
.select()
.apis(basePackage("se.magnus.microservices.composite.product"))
.paths(PathSelectors.any())
.build()
.globalResponseMessage(POST, emptyList())
.globalResponseMessage(GET, emptyList())
.globalResponseMessage(DELETE, emptyList())
.apiInfo(new ApiInfo(
apiTitle,
apiDescription,
apiVersion,
apiTermsOfServiceUrl,
new Contact(apiContactName, apiContactUrl, apiContactEmail),
apiLicense,
apiLicenseUrl,
emptyList()
));
}
/**
* Will exposed on $HOST:$PORT/swagger-ui.html
*
* @return
*/
@Bean
public Docket apiDocumentation() {
return new Docket(SWAGGER_2)
.select()
.apis(basePackage("se.magnus.microservices.composite.product"))
.paths(PathSelectors.any())
.build()
.globalResponseMessage(POST, emptyList())
.globalResponseMessage(GET, emptyList())
.globalResponseMessage(DELETE, emptyList())
.apiInfo(new ApiInfo(
apiTitle,
apiDescription,
apiVersion,
apiTermsOfServiceUrl,
new Contact(apiContactName, apiContactUrl, apiContactEmail),
apiLicense,
apiLicenseUrl,
emptyList()
));
}
/**
* Will exposed on $HOST:$PORT/swagger-ui.html
*
* @return
*/
@Bean
public Docket apiDocumentation() {
return new Docket(SWAGGER_2)
.select()
.apis(basePackage("se.magnus.microservices.composite.product"))
.paths(PathSelectors.any())
.build()
.globalResponseMessage(POST, emptyList())
.globalResponseMessage(GET, emptyList())
.globalResponseMessage(DELETE, emptyList())
.apiInfo(new ApiInfo(
apiTitle,
apiDescription,
apiVersion,
apiTermsOfServiceUrl,
new Contact(apiContactName, apiContactUrl, apiContactEmail),
apiLicense,
apiLicenseUrl,
emptyList()
));
}
/**
* Will exposed on $HOST:$PORT/swagger-ui.html
*
* @return
*/
@Bean
public Docket apiDocumentation() {
return new Docket(SWAGGER_2)
.select()
.apis(basePackage("se.magnus.microservices.composite.product"))
.paths(PathSelectors.any())
.build()
.globalResponseMessage(POST, emptyList())
.globalResponseMessage(GET, emptyList())
.globalResponseMessage(DELETE, emptyList())
.apiInfo(new ApiInfo(
apiTitle,
apiDescription,
apiVersion,
apiTermsOfServiceUrl,
new Contact(apiContactName, apiContactUrl, apiContactEmail),
apiLicense,
apiLicenseUrl,
emptyList()
));
}
/**
* Will exposed on $HOST:$PORT/swagger-ui.html
*
* @return
*/
@Bean
public Docket apiDocumentation() {
return new Docket(SWAGGER_2)
.select()
.apis(basePackage("se.magnus.microservices.composite.product"))
.paths(PathSelectors.any())
.build()
.globalResponseMessage(POST, emptyList())
.globalResponseMessage(GET, emptyList())
.globalResponseMessage(DELETE, emptyList())
.apiInfo(new ApiInfo(
apiTitle,
apiDescription,
apiVersion,
apiTermsOfServiceUrl,
new Contact(apiContactName, apiContactUrl, apiContactEmail),
apiLicense,
apiLicenseUrl,
emptyList()
));
}
ApiInfo apiInfo() {
final Properties properties = new Properties();
try (InputStream stream = this.getClass().getResourceAsStream("/version.properties")) {
if (stream != null) {
properties.load(stream);
}
} catch (IOException ex) {
// ignore
}
String version = properties.getProperty("version", "unknown");
return new ApiInfoBuilder()
.title("OpenAPI Generator Online")
.description("This is an online openapi generator server. You can find out more at https://github.com/OpenAPITools/openapi-generator.")
.license("Apache 2.0")
.licenseUrl("https://www.apache.org/licenses/LICENSE-2.0.html")
.termsOfServiceUrl("")
.version(version)
.contact(new Contact("","", ""))
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
// 文档标题
.title("springboot利用swagger构建api文档")
// 文档详细描述
.description("简单优雅的restfun风格,http://www.lhdyx.cn")
// 作者
.contact(new Contact("小东", "http://www.lhdyx.cn", "[email protected]"))
// 版本号
.version("1.0")
.build();
}
/**
* 添加摘要信息
*/
private ApiInfo apiInfo() {
// 用ApiInfoBuilder进行定制
return new ApiInfoBuilder()
// 设置标题
.title("标题:DimpleBlog后台管理系统")
// 描述
.description("代码开源:https://github.com/DimpleFeng/DimpleBlog")
// 作者信息
.contact(new Contact(dimpleBlogConfig.getName(), "https://www.bianxiaofeng.com", "[email protected]"))
// 版本
.version("版本号:" + dimpleBlogConfig.getVersion())
.build();
}
private ApiInfo buildApiInf() {
return new ApiInfoBuilder()
.title("系统RESTful API文档")
.contact(new Contact("mrbird", "https://mrbird.cc", "[email protected]"))
.version("1.0")
.build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("BlockChain-Java 项目 API 文档.")
.description("我的博客网站:http://r9it.com,欢迎大家访问。")
.contact(new Contact("RockYang", "http://ww.r9it.com", "[email protected]"))
.version("v1.0")
.build();
}
private ApiInfo metaData() {
Contact contact = new Contact("Adorsys GmbH", "https://www.adorsys.de",
"[email protected]");
return new ApiInfo(
"Online banking",
"Implementation of backend for online banking UI. "
+ "We have 3 preloaded users in Ledgers: <b>marion.mueller</b>, <b>anton.brueckner</b>, <b>max.musterman</b> all with the PIN <b>12345</b>. "
+ "You can use the User Login API from Ledgers <b>/users/authorise2</b> endpoint to gain an access token. Then use the access token with the prefix 'Bearer ' to Authorize on this ui.",
buildProperties.getVersion() + " " + buildProperties.get("build.number"),
"Terms of Service: to be edited...",
contact,
"Apache License Version 2.0",
"https://www.apache.org/licenses/LICENSE-2.0",
new ArrayList<>());
}
/**
* 添加摘要信息
*/
private ApiInfo apiInfo()
{
// 用ApiInfoBuilder进行定制
return new ApiInfoBuilder()
.title("标题:LuckyFrame管理系统_接口文档")
.description("描述:用于管理集团旗下公司的人员信息,具体包括XXX,XXX模块...")
.contact(new Contact(lfConfig.getName(), null, null))
.version("版本号:" + lfConfig.getVersion())
.build();
}
private ApiInfo apiEndPointsInfo() {
return new ApiInfoBuilder().title("Account REST API")
.description("Staffjoy Account REST API")
.contact(new Contact("bobo", "https://github.com/jskillcloud", "[email protected]"))
.license("The MIT License")
.licenseUrl("https://opensource.org/licenses/MIT")
.version("V2")
.build();
}
private ApiInfo apiEndPointsInfo() {
return new ApiInfoBuilder().title("Company REST API")
.description("Staffjoy Company REST API")
.contact(new Contact("bobo", "https://github.com/jskillcloud", "[email protected]"))
.license("The MIT License")
.licenseUrl("https://opensource.org/licenses/MIT")
.version("V2")
.build();
}
private ApiInfo metaData() {
return new ApiInfo(
"Spring Boot REST API",
"Spring Boot REST API for Spellchecker",
"1.0",
"Terms of service",
new Contact("Lucky Sharma", "", "[email protected]"),
"",
"",
new ArrayList<>());
}
private ApiInfo apiInfo(){
return new ApiInfoBuilder()
.title("支付测试")
.description("通灵支付")
.license("yx")
.licenseUrl("http://www.apache.org/")
.contact(new Contact("yx","官网地址url","email地址"))
.version("0.0.1")
.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("Basic Plugin Example RESTful APIs")
.description("基本插件案例模块接口描述")
.termsOfServiceUrl("http://127.0.0.1")
.contact(new Contact("StartBlues", "", ""))
.version("2.1.1")
.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("利用swagger2构建【spring-boot-demo-all】系统api文档")
.description("基于Spring Boot 2.x为基础上集成其他组件的案例, 方便大家学习使用。<br/>接口访问地址:http://localhost:8081/, by raysonfang")
.termsOfServiceUrl("http://localhost:8081/")
.contact(new Contact("author: raysonfang, 微信公众号:Java技术干货(ID:raysonfang)", "https://www.raysonblog.cn/", "[email protected]"))
.version("1.0")
.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();
}
@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();
}
@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();
}
@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();
}
@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();
}