springfox.documentation.service.ApiInfo配置示例

最新推荐文章于 2024-01-26 11:19:46 发布
最新推荐文章于 2024-01-26 11:19:46 发布
阅读量988 收藏
点赞数
CC 4.0 BY-SA版权
文章标签： java php
原文链接：http://www.cnblogs.com/jeffen/p/6178023.html
本文提供了多个使用 springfox.documentation.service.ApiInfo 的示例代码片段，这些示例来自不同的开源项目，展示了如何配置 API 的元数据，如标题、描述、许可证等。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

Java Code Examples for springfox.documentation.service.ApiInfo

The following are top voted examples for showing how to use springfox.documentation.service.ApiInfo. These examples are extracted from open source projects. You can vote up the examples you like and your votes will be used in our system to product more good examples. 

Example 1
Project: Learny---Server   File: SwaggerConfig.java View source code7 votesvote downvote up
private ApiInfo apiInfo() {return new ApiInfoBuilder().title("Learny Api").description("Hier steht die Beschreibung der Api").termsOfServiceUrl("http://springfox.io").contact("springfox").license("Apache License Version 2.0").licenseUrl("https://github.com/springfox/springfox/blob/master/LICENSE").version("2.0").build();}
Example 2
Project: jhipster_myapp   File: SwaggerConfiguration.java View source code6 votesvote downvote up
/**
 * API Info as it appears on the swagger-ui page.
 */private ApiInfo apiInfo() {return new ApiInfo(
        propertyResolver.getProperty("title"),
        propertyResolver.getProperty("description"),
        propertyResolver.getProperty("version"),
        propertyResolver.getProperty("termsOfServiceUrl"),
        propertyResolver.getProperty("contact"),
        propertyResolver.getProperty("license"),
        propertyResolver.getProperty("licenseUrl"));}
Example 3
Project: swagger-codegen   File: SwaggerConfig.java View source code6 votesvote downvote up
@BeanApiInfo apiInfo() {ApiInfo apiInfo = new ApiInfo("Swagger Petstore","This is a sample server Petstore server.  You can find out more about Swagger at <a href=\"http://swagger.io\">http://swagger.io</a> or on irc.freenode.net, #swagger.  For this sample, you can use the api key \"special-key\" to test the authorization filters","1.0.0","","apiteam@swagger.io","Apache 2.0","http://www.apache.org/licenses/LICENSE-2.0.html" );return apiInfo;}
Example 4
Project: jhipster-sample-app-gradle   File: SwaggerConfiguration.java View source code6 votesvote downvote up
/**
 * Swagger Springfox configuration.
 */@Beanpublic Docket swaggerSpringfoxDocket(JHipsterProperties jHipsterProperties) {
    log.debug("Starting Swagger");StopWatch watch = new StopWatch();
    watch.start();ApiInfo apiInfo = new ApiInfo(
        jHipsterProperties.getSwagger().getTitle(),
        jHipsterProperties.getSwagger().getDescription(),
        jHipsterProperties.getSwagger().getVersion(),
        jHipsterProperties.getSwagger().getTermsOfServiceUrl(),
        jHipsterProperties.getSwagger().getContact(),
        jHipsterProperties.getSwagger().getLicense(),
        jHipsterProperties.getSwagger().getLicenseUrl());Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo).genericModelSubstitutes(ResponseEntity.class).forCodeGeneration(true).genericModelSubstitutes(ResponseEntity.class).directModelSubstitute(java.time.LocalDate.class, String.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;}
Example 5
Project: menuber   File: SwaggerConfiguration.java View source code6 votesvote downvote up
/**
 * API Info as it appears on the swagger-ui page.
 */private ApiInfo apiInfo() {return new ApiInfo(
        propertyResolver.getProperty("title"),
        propertyResolver.getProperty("description"),
        propertyResolver.getProperty("version"),
        propertyResolver.getProperty("termsOfServiceUrl"),
        propertyResolver.getProperty("contact"),
        propertyResolver.getProperty("license"),
        propertyResolver.getProperty("licenseUrl"));}
Example 6
Project: jhipster-sample-app-java7   File: SwaggerConfiguration.java View source code6 votesvote downvote up
/**
 * Swagger Springfox configuration.
 */@Beanpublic Docket swaggerSpringfoxDocket(JHipsterProperties jHipsterProperties) {
    log.debug("Starting Swagger");StopWatch watch = new StopWatch();
    watch.start();ApiInfo apiInfo = new ApiInfo(
        jHipsterProperties.getSwagger().getTitle(),
        jHipsterProperties.getSwagger().getDescription(),
        jHipsterProperties.getSwagger().getVersion(),
        jHipsterProperties.getSwagger().getTermsOfServiceUrl(),
        jHipsterProperties.getSwagger().getContact(),
        jHipsterProperties.getSwagger().getLicense(),
        jHipsterProperties.getSwagger().getLicenseUrl());Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo).genericModelSubstitutes(ResponseEntity.class).forCodeGeneration(true).genericModelSubstitutes(ResponseEntity.class).directModelSubstitute(org.joda.time.LocalDate.class, String.class).directModelSubstitute(org.joda.time.LocalDateTime.class, Date.class).directModelSubstitute(org.joda.time.DateTime.class, Date.class).directModelSubstitute(java.time.LocalDate.class, String.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;}
Example 7
Project: bugkillers   File: SpringfoxConfig2.java View source code6 votesvote downvote up
private ApiInfo apiInfo() {ApiInfo apiInfo = new ApiInfo("???",
            PROJECT_NAME + " API",
            PROJECT_NAME + " ??API??","http://127.0.0.1:9081/api","hd.rd.cos@meituan.com","MTA License","MTA API License URL");return apiInfo;}
Example 8
Project: springfox-demos   File: Application.java View source code6 votesvote downvote up
private ApiInfo apiInfo() {return new ApiInfoBuilder().title("Springfox petstore API").description("Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum " +"has been the industry's standard dummy text ever since the 1500s, when an unknown printer "+ "took a " +"galley of type and scrambled it to make a type specimen book. It has survived not only five " +"centuries, but also the leap into electronic typesetting, remaining essentially unchanged. " +"It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum " +"passages, and more recently with desktop publishing software like Aldus PageMaker including " +"versions of Lorem Ipsum.").termsOfServiceUrl("http://springfox.io").contact("springfox").license("Apache License Version 2.0").licenseUrl("https://github.com/springfox/springfox/blob/master/LICENSE").version("2.0").build();}
Example 9
Project: flipper-reverse-image-search   File: SwaggerConfiguration.java View source code6 votesvote downvote up
/**
 * API Info as it appears on the swagger-ui page.
 */private ApiInfo apiInfo() {return new ApiInfo(
        propertyResolver.getProperty("title"),
        propertyResolver.getProperty("description"),
        propertyResolver.getProperty("version"),
        propertyResolver.getProperty("termsOfServiceUrl"),
        propertyResolver.getProperty("contact"),
        propertyResolver.getProperty("license"),
        propertyResolver.getProperty("licenseUrl"));}
Example 10
Project: jhipster-ionic   File: SwaggerConfiguration.java View source code6 votesvote downvote up
/**
 * API Info as it appears on the swagger-ui page.
 */private ApiInfo apiInfo() {return new ApiInfo(
        propertyResolver.getProperty("title"),
        propertyResolver.getProperty("description"),
        propertyResolver.getProperty("version"),
        propertyResolver.getProperty("termsOfServiceUrl"),
        propertyResolver.getProperty("contact"),
        propertyResolver.getProperty("license"),
        propertyResolver.getProperty("licenseUrl"));}
Example 11
Project: jhipster-sample-app   File: SwaggerConfiguration.java View source code6 votesvote downvote up
/**
 * Swagger Springfox configuration.
 */@Beanpublic Docket swaggerSpringfoxDocket(JHipsterProperties jHipsterProperties) {
    log.debug("Starting Swagger");StopWatch watch = new StopWatch();
    watch.start();ApiInfo apiInfo = new ApiInfo(
        jHipsterProperties.getSwagger().getTitle(),
        jHipsterProperties.getSwagger().getDescription(),
        jHipsterProperties.getSwagger().getVersion(),
        jHipsterProperties.getSwagger().getTermsOfServiceUrl(),
        jHipsterProperties.getSwagger().getContact(),
        jHipsterProperties.getSwagger().getLicense(),
        jHipsterProperties.getSwagger().getLicenseUrl());Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo).genericModelSubstitutes(ResponseEntity.class).forCodeGeneration(true).genericModelSubstitutes(ResponseEntity.class).directModelSubstitute(java.time.LocalDate.class, String.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;}
Example 12
Project: jhipster-sample-app-mongodb   File: SwaggerConfiguration.java View source code6 votesvote downvote up
/**
 * Swagger Springfox configuration.
 */@Beanpublic Docket swaggerSpringfoxDocket(JHipsterProperties jHipsterProperties) {
    log.debug("Starting Swagger");StopWatch watch = new StopWatch();
    watch.start();ApiInfo apiInfo = new ApiInfo(
        jHipsterProperties.getSwagger().getTitle(),
        jHipsterProperties.getSwagger().getDescription(),
        jHipsterProperties.getSwagger().getVersion(),
        jHipsterProperties.getSwagger().getTermsOfServiceUrl(),
        jHipsterProperties.getSwagger().getContact(),
        jHipsterProperties.getSwagger().getLicense(),
        jHipsterProperties.getSwagger().getLicenseUrl());Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo).genericModelSubstitutes(ResponseEntity.class).forCodeGeneration(true).genericModelSubstitutes(ResponseEntity.class).directModelSubstitute(java.time.LocalDate.class, String.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;}
Example 13
Project: spring-swagger2markup-demo   File: SwaggerConfig.java View source code6 votesvote downvote up
private ApiInfo apiInfo() {return new ApiInfoBuilder().title("Swagger Petstore").description("Petstore API Description").contact("apiteam@wordnik.com").license("Apache 2.0").licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html").version("1.0.0").build();}
Example 14
Project: fullstop   File: SwaggerConfig.java View source code6 votesvote downvote up
@BeanApiInfo apiInfo() {return new ApiInfo("Fullstop API","Audit reporting","","","","Apache 2.0","http://www.apache.org/licenses/LICENSE-2.0.html");}
Example 15
Project: jhipster-sample-app-elasticsearch   File: SwaggerConfiguration.java View source code6 votesvote downvote up
/**
 * Swagger Springfox configuration.
 */@Beanpublic Docket swaggerSpringfoxDocket(JHipsterProperties jHipsterProperties) {
    log.debug("Starting Swagger");StopWatch watch = new StopWatch();
    watch.start();ApiInfo apiInfo = new ApiInfo(
        jHipsterProperties.getSwagger().getTitle(),
        jHipsterProperties.getSwagger().getDescription(),
        jHipsterProperties.getSwagger().getVersion(),
        jHipsterProperties.getSwagger().getTermsOfServiceUrl(),
        jHipsterProperties.getSwagger().getContact(),
        jHipsterProperties.getSwagger().getLicense(),
        jHipsterProperties.getSwagger().getLicenseUrl());Docket docket = new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo).genericModelSubstitutes(ResponseEntity.class).forCodeGeneration(true).genericModelSubstitutes(ResponseEntity.class).directModelSubstitute(java.time.LocalDate.class, String.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;}
Example 16
Project: JTL-FIleService   File: SwaggerConfiguration.java View source code6 votesvote downvote up
/**
 * API Info as it appears on the swagger-ui page.
 */private ApiInfo apiInfo() {return new ApiInfo(
        propertyResolver.getProperty("title"),
        propertyResolver.getProperty("description"),
        propertyResolver.getProperty("version"),
        propertyResolver.getProperty("termsOfServiceUrl"),
        propertyResolver.getProperty("contact"),
        propertyResolver.getProperty("license"),
        propertyResolver.getProperty("licenseUrl"));}
Example 17
Project: ABC-Go   File: SwaggerConfiguration.java View source code6 votesvote downvote up
/**
 * API Info as it appears on the swagger-ui page.
 */private ApiInfo apiInfo() {return new ApiInfo(
        propertyResolver.getProperty("title"),
        propertyResolver.getProperty("description"),
        propertyResolver.getProperty("version"),
        propertyResolver.getProperty("termsOfServiceUrl"),
        propertyResolver.getProperty("contact"),
        propertyResolver.getProperty("license"),
        propertyResolver.getProperty("licenseUrl"));}




转载于:https://www.cnblogs.com/jeffen/p/6178023.html

报错：Cannot invoke “springfox.documentation.service.ParameterType.getIn()“
xiaodaidai的博客
05-29 1276
遇到报错：Cannot invoke "springfox.documentation.service.ParameterType.getIn()" because the return value of "springfox.documentation.service.RequestParameter.getIn()" is null怎么解决？
Springfox参考文档(Springfox Reference Documentation 中文)
Uhfun的博客
05-15 1769
1. 介绍 Springfox Java库套件主要是为了能够让使用Spring系列项目编写的JSON APIs自动生成机器和人类可读的规范。Springfox的工作原理是在运行时检查一次应用程序，根据Spring配置、类结构和各种编译时java注解推断API语义。 1.1. 历史 Springfox是从马蒂·皮特最初创建的一个项目演变而来的，并被命名为swagger-springmvc。很多荣誉都归功于马蒂。 1.2. 目标 支持更多针对JSON API规范和文档的不断发展的标准，例如：swagger、R
springfox 源码分析(十五) 归档得到Documentation文档对象
八一菜刀的专栏
10-07 769
通过上篇的分析,我们已经得到了ApiListing的map集合，接下来最终做文档归档,得到Documentation对象 /*** * 最终生成Documentation文档对象 * @param context * @return */ public Documentation scan(DocumentationContext context) { //...
SpringBoot项目API文档工具-Springfox Swagger
wangjinnan16的博客
08-27 586
一、简介   我们编写的Rest API，是给另外的团队使用的，所以怎样告知使用者他们需要的信息，也是API开发者需要关注，好的API文档不仅能让使用者尽快上手，而且也能让开发者日后维护项目时提高效率。这么说来，API文档越详细越好，比如笔者刚开始工作的时候，API文档都是用word一点点描写清楚的，但是这样光写文档就花了不少时间，所以如果能兼具质量与效率，那将是多么美好，可是很多时候，质量与效
Spring Boot配置Swagger增强工具
m0_38075227的博客
01-13 4192
参考knife4j官方网站：1.6 快速开始 | knife4j 一、话不多说，先看效果 1.Swagger页面这样，这里就不多做介绍 2.增强后的首页 3.API列表 4.API请求参数 5.API响应参数 个人觉得增强后看着很清晰，比原来的要好很多。 二、开始配置 1.pom.xml 配置 <dependency> <groupId>io.springfox</groupId> ...
Springfox Swagger2从入门到精通
m0_63251896的博客
01-26 3869
Swagger 是一种用于设计、构建、文档化和使用 RESTful API 的工具。Springfox 是 Swagger 在 Spring 应用中的集成库，提供了自动生成 API 文档的功能。在本文中，我们将探讨如何使用 Springfox Swagger2 在 Spring Boot 项目中生成、配置和使用 API 文档。
技术分享 | Spring Boot 集成 Swagger
hogwarts_beibei的博客
04-14 713
Swagger UI 允许任何人（无论您是开发团队还是最终用户）都可以可视化 API 资源并与之交互，而无需任何实现逻辑。它是根据您的 OpenAPI（以前称为 Swagger）规范自动生成的，具有可视化文档，可简化后端实现和客户端使用。 为什么使用Swagger 跨语言性，支持 40 多种语言，Swagger 已经慢慢演变成了 OpenAPI 规范； Swagger UI 呈现出来的是一份可交互式的 API 文档，我们可以直接在文档页面尝试 API 的调用，省去了准备复杂的调用参数的过程； 对于某
package com.dlsk.tdp.service.configs; import io.swagger.models.Info; import io.swagger.v3.oas.models.OpenAPI; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Profile; import springfox.documentation.service.Contact; @Profile("!yy-test") @Configuration public class SwaggerConfig { /** * 标题 */ private String title = "111"; /** * 简介 */ private String description = "111"; /** * 联系人 */ private String contactName = "11"; /** * 联系网址 */ private String contactUrl = "http://127.0.0.1"; /** * 联系邮箱 */ private String contactEmail = "11@qq.com"; /** * 版本号 */ private String version = "1.0.0"; @Bean public OpenAPI apiInfo() { return new OpenAPI() .info(new Info() .title(title) .description(description) .contact(new Contact(contactName, contactUrl, contactEmail)) .version(version) .build()); } } 以上代码中的.contact(new Contact(contactName, contactUrl, contactEmail))提示报错：in info cannot be applied
最新发布
04-03
首先，用户可能在使用Springfox Swagger时，按照旧版的文档或示例代码配置了Contact类，而新版的Springfox或迁移到Springdoc时，Contact对象的包路径或类名发生了变化。根据引用[4]中的信息，Springdoc使用OpenAPI 3...
SpringBoot集成Swagger
weixin_45974277的博客
02-17 2284
SpringBoot集成Swagger => springfox，两个jar包 Springfox-swagger2 swagger-swagger-ui 添加Maven依赖 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 --> <dependency> <groupId>io.spring
SpringBoot集成Swagger（Springfox）自动生成API文档
热门推荐
枣面包的博客
01-09 1万+
也许，你事先需要了解Swagger和Springfox的关系，然后我默认大家都在使用SpringBoot，并且对Java和Spring有一定的开发基础。 万物皆麻烦，直接上代码 1.pom文件 &amp;amp;lt;?xml version=&amp;quot;1.0&amp;quot; encoding=&amp;quot;UTF-8&amp;quot;?&amp;amp;gt; &amp;amp;lt;project xmlns=&a
java.lang.IllegalArgumentException: No enum constant springfox.documentation.service.ParameterType.Q
一路的博客
10-20 8749
java.lang.IllegalArgumentException: No enum constant springfox.documentation.service.ParameterType.QUERY 项目使用springBoot整合swagger时启动报错： java.lang.IllegalArgumentException: No enum constant springfox.documentation.service.ParameterType.REQUEST at java.lang.
springboot整合Swagger2之坑
a729913162的博客
06-25 8193
首先引入支持：&lt;dependency&gt; &lt;groupId&gt;io.springfox&lt;/groupId&gt; &lt;artifactId&gt;springfox-swagger2&lt;/artifactId&gt; &lt;version&gt;2.6.1&lt;/version&gt;
SpringBoot中使用springfox+swagger2书写API文档
weixin_30852367的博客
05-11 230
随着前后端的分离，借口文档变的尤其重要,springfox是通过注解的形式自动生成API文档，利用它，可以很方便的书写restful API，swagger主要用于展示springfox生成的API文档。 官网地址：http://springfox.github.io/springfox/ Springfox大致原理 springfox的大致原理就是，在项目启动的过种中，spring上下文在初始化...
基于springboot+maven的swagger2安装教程
蜗牛先生
05-30 2173
在前后端分离的模式下，一个清晰地api文档是必不可少的。而swagger就是一个非常容易搭建的api文档，只需要通过简单的配置就可以自动生成api文档。 ▍前提条件 首先需要新建一个springboot+maven的项目。 ▍大致安装流程 1、在pom.xml注入依赖； 2、新建swagger2配置文件并配置相关信息； 3、在controller中配置接口信息。 4、启...
spring boot集成swagger3
qq_36861290的博客
05-06 2798
maven依赖 <knife4j-spring-boot-starter.version>3.0.3</knife4j-spring-boot-starter.version> <springfox-boot-starter.version>3.0.0</springfox-boot-starter.version> <!--swagger相关依赖 - 开始-->
spring boot 集成swagger 3.0
weixin_67005629的博客
03-27 544
Swagger3在Swagger2的基础上进行了部分升级， 使用和Swagger2没有多少区别。一个重要的优化是依赖的引入，由之前的多个依赖变更为一个依赖，跟随springboot-starter风格，同时引入了新的开关注解 @EnableOpenApi 以代替@EnableSwagger2。一、Maven依赖二、application.yml文件配置三、添加配置。
简谈swagger的注解说明
xudong的博客
08-30 349
swagger通过注解表明该接口会生成文档，包括接口名、请求方法、参数、返回信息的等等。 • @Api：修饰整个类，描述Controller的作用 • @ApiOperation：描述一个类的一个方法，或者说一个接口 • @ApiParam：单个参数描述 • @ApiModel：用对象来接收参数 • @ApiProperty：用对象接收参数时，描述对象的一个字段 • @ApiRespo...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值