SpringBoot 整合 knfe4j ,使用 OpenAPI3 规范

SpringBoot整合knife4j使用OpenAPI3规范的步骤如下:

  1. pom.xml中添加依赖:



<dependencies>
    <!-- 添加knife4j的依赖 -->
    <dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>knife4j-spring-boot-starter</artifactId>
        <version>3.0.3</version>
    </dependency>
    <!-- 如果你使用的是Spring Boot 2.6及以上版本,请使用下面的依赖 -->
    <dependency>
        <groupId>com.github.xiaoymin</groupId>
        <artifactId>knife4j-spring-boot-starter-3</artifactId>
        <version>3.0.3</version>
    </dependency>
</dependencies>
  1. 配置application.propertiesapplication.yml,设置knife4j的相关配置:



# 设置knife4j的相关配置
knife4j:
  enable: true
  # 设置OpenAPI的相关配置
  openapi:
    scan-base-package: com.example.demo.controller # 扫描的包路径
    group: default # 分组名称
    contact:
      name: John Doe
      email: john.doe@example.com
      url: http://johndoe.com
    version: 1.0.0
    title: Example API
    description: This is a sample server Petstore server.
    termsOfServiceUrl: http://swagger.io/terms/
    license:
      name: Apache 2.0
      url: http://springdoc.org
    externalDocs:
      description: Find more info here
      url: https://swagger.io
  1. 在SpringBoot启动类上添加@EnableKnife4j注解启用knife4j:



import com.github.xiaoymin.knife4j.spring.annotations.EnableKnife4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
 
@SpringBootApplication
@EnableKnife4j // 启用Knife4j
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}
  1. 创建Controller并使用@Api@ApiOperation等注解描述接口:



import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.media.Content;
import io.swagger.v3.oas.annotations.media.Schema;
import io.swagger.v3.oas.annotations.responses.ApiResponse;
import io.swagger.v3.oas.annotations.tags.Tag;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
 
@Tag(name = "Example", description = "Example API")
@RestController
public class ExampleController {
 
    @Operation(summary 
最后修改于:2024年09月09日 11:32

评论已关闭

推荐阅读

Vue中使用mind-map实现在线思维导图
2024年08月04日
VUE
Web前端最全Vue实现免密登录跳转的方式_vue怎么样不登录返回首页,最强技术实现
2024年08月04日
VUE
vue3 项目搭建教程(基于create-vue,vite,Vite + Vue)
2024年08月04日
VUE
Vue-颜色选择器实现方案——>Vue-Color( 实战*1+ Demo*7)
2024年08月04日
VUE
Vue项目卡顿慢加载?这些优化技巧告诉你!_vue数据多渲染卡顿
2024年08月04日
VUE
vue中的keep-alive详解与应用场景
2024年08月04日
VUE
Vue、React实现excel导出功能(三种实现方式保姆级讲解)
2024年08月04日
vue-office/docx插件实现docx文件预览
2024年08月04日
VUE
java调用js文件的两种方法(支持V8引擎)
2024年08月04日
JavaScript:解决计算精度问题/mathjs/bignumber.js/big.js/decimal.js
2024年08月04日
两周从爬虫小白变大神 _yjs_js_security_passport
2024年08月04日
JS笔记(对象、函数、数组)
2024年08月04日
Markdown.js:强大的纯JavaScript Markdown解析器
2024年08月04日
Vue项目:js模拟点击a标签下载文件并重命名,URL文件地址下载方法、请求接口下载文件方法总结。
2024年08月04日
vue 父组件怎么获取子组件里面的data数据
2024年08月04日
VUE
个人开发实现AI套壳网站快速搭建(Vue+elementUI+SpringBoot)
2024年08月04日
el-table 表格封装并改造实现单元格可编辑
2024年08月04日
none
nodejs环境下创建vue项目、SSH密钥登陆!!!
2024年08月04日
vue+quill+element-ui实现视频、图片上传及缩放保姆级教程,轻松使用富文本
2024年08月04日
【three.js】22. Imported Models导入模型
2024年08月04日