# codex

**Repository Path**: evannguo/codex

## Basic Information

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

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-07-09
- **Last Updated**: 2025-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 简介 | Intro
Codex 是一个简化开发框架，它集成了SpringBoot、SpringSecurity、SpringDoc、MyBatisFlex等框架。

自动建表，快速CRUD接口生成、一个类文件 + 简洁的注解配置，快速开发通用CRUD接口。

# 特性 | Features
- 自动建表：表结构自动生成，无需手动建表
- 易于上手：会简单的 Spring Boot 基础知识即可

# Codex-Api（接口模块）
提供了@CodexApi注解，通过类文件 + 简介的注解配置，快速生成通用CRUD接口

结合SpringDoc框架的注解使用
### 类注解
- 核心 @CodexApi
```java
@CodexApi(
   name = "测试名称",     //功能名称
   desc = "用于测试描述", //描述
   power = @Power(),    //接口权限控制
   dataProxy = CodexTestProxy.class //数据代理行为，可自定义通用接口前后的行为事件	
)
public class CodexTest {
//...
}
  ```
- 字段注解 @Schema、@Search
```java
public class CodexTest {

    @Search(value = true, type = SearchType.EQ) // 用于列表接口的搜索条件，type为查询时的匹配类型
    @Schema(description = "名称") // 用于SpringDoc的字段描述，以及生成表结构时的Comment
    private String name;
    
    @Schema(description = "状态")
    private Integer status;
}
```
### 自动包装响应
本模块内置了一个全局返回值修改器，会自动对所有接口的返回值进行包装。

包装格式：
```json
{
  "code": "响应码",
  "message": "响应消息",
  "data": "响应数据"
}
```

默认是不开启状态，如需开启，请在Application启动类上使用 @CodexAutoResponse 注解

如对于某个接口想要自定义返回结果，不希望自动包装，可以在接口上方使用 @NotResponseWrap 注解
```java
@NotResponseWrap
public String test() {
    
}
```

# Codex-Security（权限模块）