# knife4j-openapi3-springboot4

**Repository Path**: aepl/knife4j-openapi3-springboot4

## Basic Information

- **Project Name**: knife4j-openapi3-springboot4
- **Description**: Knife4j-OpenAPI3-SpringBoot4(API Generator Platform) - 智能API生成平台
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-01
- **Last Updated**: 2026-02-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README


# Knife4j-OpenAPI3-SpringBoot4(API Generator Platform) - 智能API生成平台

## 项目概述

本项目基于SpringBoot4整合knife4j(swagger3)实现。

**注**：knife4j是为JavaMVC框架集成Swagger生成Api文档的增强解决方案,前身是swagger-bootstrap-ui；

取名**knife4j**是希望她能像一把匕首一样小巧,轻量,并且功能强悍!!.

## 🎯 项目特色

### ✅ 核心功能实现

- **SpringBoot4兼容**：使用 knife4j-openapi3-jakarta-spring-boot-starter 适配SpringBoot4.x
- **多模块分组**：支持按业务模块分组展示API接口
- **自定义响应码**：全局自定义HTTP响应状态码
- **增强配置**：丰富的Knife4j增强配置选项

### 🔧 技术栈

SpringBoot版本：4.0.2

Knife4j版本：4.5.0 (openapi3-jakarta-sprin...)

Java版本：17/21

Maven版本：3.x

### 🚀 快速开始

#### 1. 项目构建
```bash
mvn clean install -DskipTests
```
#### 2. 启动服务
```bash
mvn spring-boot:run
```
#### 3. 访问API文档
- **Knife4j增强界面**：http://localhost:8999/doc.html
- **原生Swagger界面**：http://localhost:8999/swagger-ui/index.html

## 📋 项目结构
```
src/main/java
    ├── com/Knife4j/				# 核心配置
    │   ├── Knife4jConfig.java		# Knife4j主配置
    │   └── StatusCode.java			# 全局响应码定义
    ├── com/call/controller/			# 控制器
    │   ├── regularGrade/			# 平时成绩模块
    │   └── intelligentScoring/		# 智能评分模块
    ├── com/ai/LangChain4j/agent2/		# AI大模型Agent模块
    └── com/example/demo/			# 主应用类
src/main/resources
    └── application.yml             		# 应用配置
```
### 🔍 依赖配置

#### 核心配置

```xml
<!-- 正确的SpringBoot依赖 -->
<!-- PUBLISHED DATA:2024-01-07 -->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>knife4j</artifactId>
    <version>4.5.0</version>
</dependency>
```

或

```xml
<!-- PUBLISHED DATA:2025-12-12 -->
<dependency>
    <groupId>io.github.lisi9988</groupId>
    <artifactId>knife4j</artifactId>
    <version>4.6.0.1</version>
</dependency>
```

#### 依赖配置

```yaml
springdoc:
    # 防止全局异常处理器的响应定义覆盖所有接口
    override-with-generic-response: false
    # 禁用接口
```
### 🎨 API分组展示

#### 1. 平均成绩模块（regularGrade-module-api）
- 路径：/api/regular-grade/*
- 功能：学生平均成绩管理

#### 2. 智能评分模块（IntelligentScoring-module-api）
- 路径：/api/intelligent-scoring/*
- 功能：AI智能评分功能

#### 3. AI大模型Agent模块（aiagent-module-api）
- 路径：/api/*
- 功能：AI大模型接口调用

### ⚙️ 自定义响应码
```
状态码| 描述
  --- | ---
  200 | 操作成功
  400 | 请求参数错误
  401 | 未授权访问
  403 | 权限不足
  404 | 资源不存在
  500 | 系统内部错误
  501 | 业务逻辑错误
```

### 🔧 常见问题解决

#### 问题1：启动报错 - Bean冲突
**解决方案**：在配置文件中添加以下配置

```yml
springdoc:
    override-with-generic-response: false
    remove-broken-reference-definitions: false
```
#### 问题2：版本兼容性问题
**解决方案**：SpringBoot3.x必须使用jakarta命名空间的依赖

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

## 📚 参考资料
Knife4j官方文档：https://docs.xiaoymin.com/docs/qick-start

SpringDoc文档：https://springdoc.org/

## 🎉 项目演示
访问页面查看项目效果：http://localhost:8999/doc.html

## ✅ 项目运行

** 状态 **：正常

** 服务器端口 **：8999

** 最后更新 **：2026-02-01