# apilog-demo

**Repository Path**: mt_0617/apilog-demo

## Basic Information

- **Project Name**: apilog-demo
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-03-24
- **Last Updated**: 2025-03-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# API Log Demo

这是一个基于Spring Boot的API日志记录解决方案，包含一个自定义的Spring Boot Starter（api-log-spring-boot-starter）和一个示例应用（student-management）。

## 项目结构

```
├── springweb-apilog/        # API日志记录starter
│   └── pom.xml             # starter的依赖配置
└── springweb/              # 示例应用
    └── pom.xml             # 示例应用的依赖配置
```

## 功能特性

- 自动记录API请求和响应日志
- 支持自定义日志记录格式和内容
- 提供灵活的配置选项
- 与Spring Boot无缝集成

## 快速开始

### 1. 添加依赖

在你的Spring Boot项目的`pom.xml`中添加以下依赖：

```xml
<dependency>
    <groupId>com.example</groupId>
    <artifactId>api-log-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>
```

### 2. 配置

在`application.properties`或`application.yml`中添加相关配置（可选）：

```yaml
api:
  log:
    enabled: true  # 启用API日志记录（默认为true）
```

## 示例应用

示例应用（student-management）展示了如何使用api-log-spring-boot-starter来记录API日志。它实现了一个简单的学生管理系统，包含基本的CRUD操作。

### 主要特性

- RESTful API设计
- 集成Swagger/OpenAPI文档
- 使用Lombok简化代码
- 演示API日志记录功能

### API文档

启动应用后，访问以下地址查看API文档：

```
http://localhost:8080/swagger-ui.html
```

## 技术栈

- Java 21
- Spring Boot 3.2.3
- SpringDoc OpenAPI 2.3.0
- Lombok

## 构建和运行

1. 首先构建并安装starter：

```bash
cd springweb-apilog
mvn clean install
```

2. 然后构建并运行示例应用：

```bash
cd ../springweb
mvn spring-boot:run
```

## 贡献

欢迎提交Issue和Pull Request！

## 许可证

[MIT License](LICENSE)