快速开始
本指南将帮助您通过模板项目创建一个基于MiCake的ASP.NET Core应用:
在开始之前,请确保您的开发环境满足以下要求:
- .NET Core 10.0 或更高版本
- Visual Studio Code 或者 Visual Studio 2022(或更高版本)
- 基本的 C# 和 ASP.NET Core 知识
- 了解 Entity Framework Core 基础(可选)
下面的步骤将指导您如何使用 MiCake 提供的dotnet new模板来快速创建一个新的项目。
在此之前请确保您已经安装了最新的.NET SDK。
如果你想基于自己的项目来构建,请参考现有项目集成
1. 安装模板集合
Section titled “1. 安装模板集合”首先,安装 MiCake.Templates 模板包:
dotnet new install MiCake.Templates2. 创建新项目
Section titled “2. 创建新项目”MiCake.Templates 提供了两个模板:
- 标准 WebAPI 模板 (
micake-webapi):基于 MiCake 的标准 ASP.NET Core Web API 模板,包含基本的 DDD 架构。 - 带 RBAC 的 WebAPI 模板 (
micake-webapi-rbac):在标准模板基础上增加了基于角色的访问控制 (RBAC) 功能。
选择合适的模板创建项目:
# 创建标准 WebAPI 项目dotnet new micake-webapi -n MyProjectName
# 或创建带 RBAC 的 WebAPI 项目dotnet new micake-webapi-rbac -n MyProjectName3. 配置和运行项目
Section titled “3. 配置和运行项目”进入项目目录:
cd MyProjectName构建项目:
dotnet build运行项目:
dotnet run项目启动后,您可以在浏览器中访问 http://localhost:port/scalar/v1 查看 API 文档(开发环境默认启用 Scalar OpenAPI 界面)。
4. 数据库配置(可选)
Section titled “4. 数据库配置(可选)”模板默认使用 PostgreSQL。如果需要运行完整功能,请确保数据库已配置:
- 更新
appsettings.Development.json中的连接字符串。 - 使用 EF Core 迁移工具初始化数据库(参考项目中的 README 文件)。
恭喜!您已经成功搭建了一个基于 MiCake 的 DDD 应用。接下来可以:
如果遇到问题,可以:
- 查看 GitHub Issues
- 阅读详细的功能文档
- 参考示例代码