3.6.xx版本SpringBoot创建基于Swagger接口文档

介绍

基于Swagger构建的JavaAPI文档工具,实现后端功能的测试,并撰写API接口文档。

方法

  • pom.xml中引入依赖,要注意的是,本依赖使用的SpringBoot版本为3.6.xx

    xml 复制代码
    <!--Knife4j-->
            <dependency>
                <groupId>com.github.xiaoymin</groupId>
                <artifactId>knife4j-openapi2-spring-boot-starter</artifactId>
                <version>4.4.0</version>
            </dependency>
  • application.yaml或yml添加相关配置

    yaml 复制代码
    server:
      port: 9080 #后端启动端口
    knife4j:
      enable: true # 是否开启knife4j
      openapi:
        title: XX项目API接口文档 # 标题
        description: "XX项API接口文档" # 简介
        email: "shijieheping@666.com" # 邮箱
        concat: 炜哥 # 联系人
        url: https://docs.xiaominfo.com # 网址
        version: v1.0.0 # 版本
        license: Apache 2.0 # 许可证
        license-url: https://stackoverflow.com/ # 许可证地址
        terms-of-service-url: https://stackoverflow.com/ # 服务条款
        group:
          default:
            group-name: default # 分组名称
            api-rule: package # 分组规则
            api-rule-resources: # 分组规则对应的包名
              - cn.sightsnow.zh.controller
  • 浏览器地址栏输入接口文档地址打开接口文档,其中9080为本机的后端端口

    http 复制代码
    http://localhost:9080/doc.html
  • 最后如果启动报错,请查看SpringBoot版本是否高于3.7,请修改Swagger版本或SpringBoot版本。如果访问地址后无接口文档,请先试着检查是否有设置页面拦截。

相关推荐
小_太_阳几秒前
Scala_【2】变量和数据类型
开发语言·后端·scala·intellij-idea
直裾3 分钟前
scala借阅图书保存记录(三)
开发语言·后端·scala
黑胡子大叔的小屋21 分钟前
基于springboot的海洋知识服务平台的设计与实现
java·spring boot·毕业设计
ThisIsClark24 分钟前
【后端面试总结】深入解析进程和线程的区别
java·jvm·面试
星就前端叭1 小时前
【开源】一款基于Vue3 + WebRTC + Node + SRS + FFmpeg搭建的直播间项目
前端·后端·开源·webrtc
计算机毕设孵化场1 小时前
计算机毕设-基于springboot的校园社交平台的设计与实现(附源码+lw+ppt+开题报告)
spring boot·课程设计·计算机毕设论文·计算机毕设ppt·计算机毕业设计选题推荐·计算机选题推荐·校园社交平台
雷神乐乐1 小时前
Spring学习(一)——Sping-XML
java·学习·spring
苹果醋32 小时前
Golang的文件加密工具
运维·vue.js·spring boot·nginx·课程设计
小林coding2 小时前
阿里云 Java 后端一面,什么难度?
java·后端·mysql·spring·阿里云
AI理性派思考者2 小时前
【保姆教程】手把手教你在Linux系统搭建早期alpha项目cysic的验证者&证明者
后端·github·gpu