3、springboot3 vue3开发平台-后端-swagger,knife4j整合

1. knife4j 简介

  • Knife4j是一个集Swagger2 和 OpenAPI3为一体的增强解决方案帮助开发者快速聚合使用OpenAPI规范。
  • 兼容OpenAPI3, 使用更简介
  • 界面较swagger 好看,文档导出、测试功能更简介方便
    官网: https://doc.xiaominfo.com/

2. 引入依赖

父pom.xml 管理依赖版本
在这里插入图片描述
suppor模块引入依赖:

 <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-openapi3-jakarta-spring-boot-starter</artifactId>
        </dependency>

start模块添加配置:

# springdoc-openapi项目配置
springdoc:
  swagger-ui:
    path: /swagger-ui.html
    tags-sorter: alpha
    operations-sorter: alpha
  api-docs:
    path: /v3/api-docs
  group-configs:
    - group: 系统管理
      paths-to-match: '/**'
      packages-to-scan: com.ylp.sys
    # 添加其他模块的文档
# knife4j的增强配置,不需要增强可以不配
knife4j:
  enable: true
  setting:
    language: zh_cn

3. 简单配置

support模块下对knife4简单配置, 更多配置参考官网和openapi
在这里插入图片描述

package com.ylp.support.knife4j;

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;


@Configuration
public class Knife4jConfig {
    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("项目 - 接口文档")
                        .description("项目简介,api后台接口")
                        .version("V1.0")
                        .contact(new Contact().name("cc"))
                );
    }

}

4 . 测试

在这里插入图片描述
访问地址:http://ip:port/doc.html ( http://127.0.0.1:9999/doc.html )
在这里插入图片描述

  • 11
    点赞
  • 4
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

不知所云,

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值