Jdk17 +Springboot3.1.3 集成 OpenApi+Knife4j

之前大量的去找openApi集成knife4j的资料发现有很多的问题,现在这个是我整理了网上很多集成教程修改的,基于Jdk17+Springboot3.1.3 +knife4j-openapi3-jakarta-spring-boot-starter

在pom中加入如下配置

<dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.2</version> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.28</version> </dependency> <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId> knife4j-openapi3-jakarta-spring-boot-starter </artifactId> <version>4.3.0</version> </dependency> <dependency> <groupId>javax.validation</groupId> <artifactId>validation-api</artifactId> <version>2.0.1.Final</version> </dependency>

配置yml文件

# spring-doc 接口文档
springdoc:
  api-docs:
    enabled: true
  group-configs:
    - group: 'default'
      paths-to-match: '/**'
      packages-to-scan: com.changan.afterservicecommon
  default-flat-param-object: true
# knife4j的增强配置,不需要增强可以不配
knife4j:
  enable: true
  setting:
    language: zh_cn

packages-to-scan为你的项目包名称如我的项目包路径为com.changan.afterservicecommon

创建config配置类

package com.changan.afterservicecommon.config;

import io.swagger.v3.oas.models.ExternalDocumentation;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

 /**
    * @author      : cosmos
    * @since       : 2023-12-05 13:49:16
    * @description : openapi 界面配置
    * @param       :
    * @return      : null
  */

@Configuration
public class OpenApiConfig {
   

    @Bean
    public OpenAPI openAPI() {
   
        return new OpenAPI()
                .info(new Info().title("Knife4j And OpenApi 3")
                        .description("Knife4j OpenApi 3 example application")
                        .version
  • 21
    点赞
  • 19
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
集成Knife4j需要以下步骤: 1. 在pom.xml文件中添加Knife4j的依赖: ```xml <dependency> <groupId>com.github.xiaoymin</groupId> <artifactId>knife4j-spring-boot-starter</artifactId> <version>3.0.2</version> </dependency> ``` 2. 在SpringBoot启动类上添加@EnableKnife4j注解: ```java @SpringBootApplication @EnableKnife4j public class Application { public static void main(String[] args) { SpringApplication.run(Application.class, args); } } ``` 3. 配置Knife4j信息,可以在application.yml或application.properties中添加以下配置: ```yaml knife4j: title: Knife4j接口文档 description: Knife4j接口文档 version: 1.0.0 contact: name: knife4j url: https://github.com/xiaoymin/Knife4j email: knife4j@sina.com ``` 4. 在Controller类上添加@Api注解,可以在类上添加@Api(tags = "XXX")注解指定标签: ```java @RestController @Api(tags = "用户管理") public class UserController { @GetMapping("/users") @ApiOperation(value = "获取用户列表") public List<User> getUsers() { // ... } // ... } ``` 5. 启动应用后,在浏览器中访问http://localhost:port/doc.html即可查看接口文档。 注意:如果您的应用是一个WebMvc项目,需要在WebMvcConfigurerAdapter实现类中添加以下配置: ```java @Configuration public class Knife4jConfiguration extends WebMvcConfigurerAdapter { @Override public void addResourceHandlers(ResourceHandlerRegistry registry) { registry.addResourceHandler("doc.html") .addResourceLocations("classpath:/META-INF/resources/"); registry.addResourceHandler("/webjars/**") .addResourceLocations("classpath:/META-INF/resources/webjars/"); } } ```

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值