首页
学习
活动
专区
工具
TVP
发布
精选内容/技术社群/优惠产品,尽在小程序
立即前往

Spring boot应用程序,swagger-ui ApiInfo()方法已弃用。需要替代方案

对于Spring Boot应用程序中swagger-ui的ApiInfo()方法已弃用的替代方案,可以使用Swagger2的Docket类来替代。Docket类是Swagger2的主要配置类,用于配置Swagger的各种属性。

在使用Docket类时,可以通过调用其apiInfo()方法来设置API文档的基本信息,包括标题、描述、版本等。具体可以参考以下示例代码:

代码语言:txt
复制
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("API文档")
                .description("这是一个示例API文档")
                .version("1.0.0")
                .build();
    }
}

在上述示例中,通过调用apiInfo()方法设置了API文档的基本信息,包括标题为"API文档",描述为"这是一个示例API文档",版本为"1.0.0"。同时,通过apis()方法指定了需要生成API文档的Controller所在的包路径。

推荐的腾讯云相关产品是腾讯云API网关(API Gateway),它可以帮助开发者更好地管理和发布API接口,并提供了丰富的API文档管理功能。腾讯云API网关的产品介绍和文档链接如下:

产品介绍:腾讯云API网关

文档链接:API网关文档

通过使用腾讯云API网关,可以更方便地管理和发布Spring Boot应用程序的API接口,并提供完善的API文档管理功能。

页面内容是否对你有帮助?
有帮助
没帮助

相关·内容

让你的API文档更亮眼:Spring BootSwagger-UI完美整合!

前言 在实际开发过程中,我们经常需要编写API文档来描述接口的调用方法、参数、返回值等信息。为了提高开发效率和维护便利性,Swagger-UI成为了API文档自动生成的一种流行方案。...本文将介绍如何利用Spring BootSwagger-UI实现在线API文档。 2....摘要 本文主要涉及以下内容: Swagger-UI的介绍 Spring Boot整合Swagger-UI 示例代码和测试方法 总结 3....Spring Boot整合Swagger-UI Spring BootSwagger-UI整合非常简单,只需要按照以下步骤即可。...4.4 运行测试 最后,运行Spring Boot应用程序,然后在浏览器中访问http://localhost:8080/swagger-ui.html,就可以看到生成的API文档了。

1.8K41
  • Swagger3.0官方starter诞生,可以扔掉那些野生starter了

    Swagger3.0官方starter诞生,可以扔掉那些野生starter了 swagger介绍 对于 Rest API 来说很重要的一部分内容就是文档,Swagger 为我们提供了一套通过代码和注解自动生成文档的方法...在2.9之前被的api已经被积极地删除,并且标记了将在不久的将来消失的新api。所以请注意这些,并报告任何遗漏的内容。...几乎只需要spring-plugin,swagger-core ,现有的swagger2注释将继续工作并丰富openapi3.0规范。...兼容性说明: 需要Java 8 需要Spring5.x(未在早期版本中测试) 需要SpringBoot 2.2+(未在早期版本中测试) 注意: 应用主类增加注解@EnableOpenApi,删除之前版本的...:8080/swagger-ui/即可。

    2.1K31

    SpringBoot实战:整合Swagger3实现在线Api文档

    Swagger 接口文档地址 三、效果验证 1、控制台输出 2、Swagger-UI ---- 一、项目介绍与条件准备 1、项目使用框架/模块介绍 Swagger-UISwagger-UI 是 HTML...2、Swagger-UI 常用注解 @Api 注解:用于修饰 Controller 类,生成 Controller 相关文档信息; @ApiOperation 注解:用于修饰 Controller 类中的方法...├── mapper — 数据访问层,与数据库交互为 service 提供接口 ├── entity — 实体对象 ​ ├── converter — 实体对象转换器 ​ ├── dto — 持久层需要的实体对象...(用于服务层与持久层之间的数据传输对象) ​ └── vo — 视图层需要的实体对象(用于服务层与视图层之间的数据传输对象) ├── utils — 工具类 └── Application.java —...; import springfox.documentation.spring.web.plugins.WebFluxRequestHandlerProvider; import springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider

    1.2K30

    谁家面试往死里问 Swagger 啊?

    org.springframework.boot spring-boot-starter-web</artifactId...(SwaggerApplication.java:10) [classes/:na]解决方案这个错误的解决办法比较多,我整理了四种解决此问题的方案,你看哪个更合适你。...Swagger框架需要通过解析和扫描带有注解的Controller类和方法来生成API文档。...通过过滤掉存在PatternParser的映射,意味着我们可以将Swagger特定的HandlerMappings添加到HandlerMappings列表中,从而使用自定义的设置来替代原有的HandlerMappings...图片securityContextssecuritySchemes方法中虽然设置了鉴权字段,但此时在测试接口的时候不会自动在 header中加上鉴权字段和值,还要配置API的安全上下文,指定哪些接口需要进行安全认证

    43040

    Swagger3就是比2简单粗暴

    接口文档总是很烦人,我曾经尝试过Postman来编写和分享项目文档,感觉还不错。但是最近项目紧,我没有额外的时间可以花在它上面,这也导致我尝试YApi(另外一种文档)的计划泡汤了。...Swagger3集成 Swagger目前最新版本是3.0.0,在Spring Boot应用中集成Swagger3比老的Swagger2简单多了,它提供了一个Starter组件。...因为在springfox-boot-starter-3.0.0.jar下你可以找到一个spring.factories,熟悉Spring Boot的同学都知道这个是一个Spring Boot 特有的SPI...解决方法是@RestControllerAdvice控制好生效的包范围,也就是配置其basePackages参数就行了,这个潜在的冲突浪费我了一个多小时。...所需要用到的静态资源,允许访问 web.ignoring().antMatchers( "/swagger-ui.html", "/swagger-ui/**",

    4.3K60

    Swagger 3.0快速入门

    数据访问层dao 前端:前端控制层、视图层 前后端交互:通过API接口 前后端相对独立,松耦合,甚至可以部署在不同的服务器上 随之产生的问题:前后端联调,前端人员和后端人员无法做到及时协商,尽早解决 解决方案...---- SpringFox 3.0.0 发布 此版本的亮点: Spring5,Webflux支持(仅支持请求映射,尚不支持功能端点)。 Spring Integration支持。...SpringBoot支持springfox Boot starter依赖性(零配置、自动配置支持)。 支持OpenApi 3.0.3。 零依赖。...几乎只需要spring-plugin,swagger-core ,现有的swagger2注释将继续工作并丰富openapi3.0规范。...兼容性说明: 需要Java 8 需要Spring5.x(未在早期版本中测试) 需要SpringBoot 2.2+(未在早期版本中测试) ---- swagger3.0 与2.xx配置差异: 应用主类添加注解

    1.4K10
    领券