Enum to API - 项目介绍

项目简介

Enum to API 是一个 Spring Boot 工具，能够自动扫描项目中的 Java 枚举类并将其暴露为 REST API 端点。开发者只需使用 @ExportEnum 和 @EnumScan 注解标记枚举，系统就会在启动时自动扫描并生成对应的 API 接口，无需手动编写任何 Controller 代码。

使用示例

                // 1. 标记需要扫描的包

                @EnumScan(basePackages = "com.example.enums")

                public class AppConfig {}

                // 2. 在枚举类上添加导出注解

                @ExportEnum

                public enum Status {

                  ACTIVE("激活", "1"),

                  INACTIVE("未激活", "0");

                  private final String label;

                  private final String value;

                }

                // 3. 自动生成的 API 端点

                GET /api/enum/values/Status

                // → [{"label":"激活","value":"1"}, {"label":"未激活","value":"0"}]

核心功能

声明式注解配置 — @ExportEnum + @EnumScan 零侵入式接入
启动时自动扫描 — 应用启动时自动发现并注册枚举 API
灵活字段映射 — 通过 label 和 value 注解参数自定义输出字段
内存缓存 — 扫描结果缓存在内存中，无数据库依赖
RESTful API — 统一的 GET /api/enum/values/{enumName} 端点格式

技术栈一览

Java 17 Spring Boot 3.2 Spring Web MVC Maven 自定义注解反射扫描