使用指南
按功能组织的接入文档,覆盖接口响应、接口文档、自动建表三类能力,5 分钟启动,10 分钟开发第一个功能。
开始使用
工坊由两部分组成:
本文档站点专注于讲清主模块:按模块组织,每个模块独立讲清楚为什么这样设计、怎么接入。子分支以索引 + 外链形式在项目介绍中维护,文档站不再重复内嵌博客长文。
| 模块 | 定位 | 文档状态 |
|---|---|---|
forge-ddl | 注解驱动的自动建表 | ✅ 阶段① 注解扫描已落地 |
forge-api | 通用 Result / 异常 / 常量 | 🚧 文档待补 |
forge-core | 全局响应包装 / 异常处理 / 注解版本路由 | ✅ 已落地,见「接口响应」 |
forge-processor | 编译期注解互斥校验 | ✅ 已落地,见「接口响应 › 编译期互斥校验」 |
forge-swagger | Knife4j + Swagger3 接入 | ✅ 已落地,见「接口文档」 |
forge-metadata / forge-data | 模型定义 / 枚举 / CRUD / 关系字段 / 逻辑删除 | ✅ 已落地,见「数据建模」 |
forge-module / forge-boot | 模块化 / SPI / 启动生命周期编排 | ✅ 已落地,见「应用架构」 |
forge-auth | RBAC / @Public / SaToken / SpringSecurity 双实现 | ✅ 已落地,见「安全鉴权」 |
forge-samples-* | 业务示例:API / 核心 / 启动 | 🚧 文档待补 |
模块文档随代码迭代逐步补齐。
dp/*(设计模式系列)与craft/*(避坑系列)以分支 + 博客形式维护,索引见项目介绍 · 学习资源。