coder-common-thin-backend/coder-common-thin-web/pom.xml
Leo f3bc4ace1f feat: 集成OpenAPI 3.0文档并添加中文接口注解
 新增功能:
- 集成SpringDoc OpenAPI 3.0依赖和配置
- 创建OpenApiConfig配置类,设置中文API文档信息
- 为所有Controller类添加@Tag中文标签注解
- 为所有Controller方法添加@Operation中文描述注解

📝 涉及模块:
- 根pom.xml: 添加springdoc依赖版本管理
- coder-common-thin-web: 添加OpenAPI依赖和配置
- coder-common-thin-system: 添加OpenAPI依赖
- application-dev.yml: 配置SpringDoc参数

🎯 改进内容:
- 用户管理: 15个接口方法的中文注解
- 登录认证: 3个接口方法的中文注解
- 验证码管理: 2个接口方法的中文注解
- 菜单管理: 13个接口方法的中文注解
- 角色管理: 11个接口方法的中文注解
- 文件管理: 2个接口方法的中文注解
- 系统文件管理: 7个接口方法的中文注解
- 图库管理: 7个接口方法的中文注解
- 登录日志: 7个接口方法的中文注解

🚀 使用效果:
- 访问 /swagger-ui.html 可查看完整中文API文档
- 同步到Apifox时显示中文接口名称和描述
- API按功能模块分组,便于管理和使用
2025-07-05 16:35:59 +08:00

93 lines
3.4 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.leocoder.thin</groupId>
<artifactId>coder-common-thin-backend</artifactId>
<version>${revision}</version>
</parent>
<name>coder-common-thin-web</name>
<artifactId>coder-common-thin-web</artifactId>
<description>入口项目,负责打包</description>
<dependencies>
<!-- SpringBoot Web容器 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- Sa-Token模块和系统管理模块 -->
<dependency>
<groupId>org.leocoder.thin</groupId>
<artifactId>coder-common-thin-system</artifactId>
<version>${revision}</version>
</dependency>
<!-- SpringDoc OpenAPI 3.0 -->
<dependency>
<groupId>org.springdoc</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
</dependency>
<!-- 定时任务 -->
<!-- <dependency> -->
<!-- <groupId>org.leocoder.thin</groupId> -->
<!-- <artifactId>coder-common-thin-job</artifactId> -->
<!-- <version>${revision}</version> -->
<!-- </dependency> -->
<!-- 代码生成器 -->
<!-- <dependency> -->
<!-- <groupId>org.leocoder.thin</groupId> -->
<!-- <artifactId>coder-common-thin-generator</artifactId> -->
<!-- <version>${revision}</version> -->
<!-- </dependency> -->
<!-- 监控模块 -->
<!-- <dependency> -->
<!-- <groupId>org.leocoder.thin</groupId> -->
<!-- <artifactId>coder-common-thin-monitor</artifactId> -->
<!-- <version>${revision}</version> -->
<!-- </dependency> -->
<!-- 热榜API模块 -->
<!-- <dependency> -->
<!-- <groupId>org.leocoder.thin</groupId> -->
<!-- <artifactId>coder-hotlist-api</artifactId> -->
<!-- <version>${revision}</version> -->
<!-- </dependency> -->
</dependencies>
<build>
<!-- 指定打包名字 -->
<finalName>coder-admin</finalName>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>${springboot.version}</version>
<executions>
<execution>
<goals>
<goal>repackage</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.xml</include>
</includes>
</resource>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>**/*</include>
</includes>
</resource>
</resources>
</build>
</project>