XuDaxia.ApiFramework.Templates 0.3.3

XuDaxia API Framework

面向 CMS、CRM、OA 和企业网站项目的模块化企业应用 API 快速开发框架。

当前框架提供 SQL Server/MySQL 项目模板，并在创建时固定选择 CodeFirst 或 DatabaseFirst 数据模式。CodeFirst 模式包含 EF Core 迁移、管理员初始化、JWT/Refresh Token、用户角色权限、系统配置、组织、审计、文件管理和 Example CRUD；DatabaseFirst 模式不携带迁移和框架业务表，通过反向工程适配现有数据库。两种模式都提供健康检查、Problem Details、限流、OpenAPI、Scalar 调试页面和 AppKey + HMAC-SHA256 External API 认证。使用方式见 External API 认证。

创建项目

获取版本化模板包后，不需要克隆框架仓库即可安装：

dotnet new install XuDaxia.ApiFramework.Templates@0.3.3
dotnet new xudaxia-api -n "Company.Project" `
  --database SqlServer `
  --dataMode CodeFirst

框架维护者在仓库根目录执行以下命令生成 .nupkg 和 SHA256 文件：

& "packaging/pack-template.ps1"

产物默认位于 artifacts/packages。--database 可选 SqlServer/MySql，--dataMode 可选 CodeFirst/DatabaseFirst。生成后进入项目目录，按快速上手完成数据库连接和 API 启动；已有库项目另见已有数据库接入。认证、模块开发和上线检查分别见认证与授权、模块开发和安全清单。

目录

XuDaxia/
├── src/
│   ├── XuDaxia.Api/
│   ├── XuDaxia.Core/
│   ├── XuDaxia.Infrastructure/
│   ├── XuDaxia.DbMigrator/
│   └── Modules/
├── tests/
├── deploy/
├── docs/
└── scripts/

本地验证

dotnet restore "XuDaxia/XuDaxia.slnx"
dotnet build "XuDaxia/XuDaxia.slnx" --no-restore
dotnet test "XuDaxia/XuDaxia.slnx" --no-build --no-restore
dotnet format "XuDaxia/XuDaxia.slnx" --verify-no-changes --no-restore

框架由许大虾设计和维护。