SSW净架构模板使用指南

项目简介

此文档介绍了如何使用SSW净架构模板创建一个新的ASP.NET Core API项目。该模板提供了完整的基础设施和应用层结构，帮助开发者快速上手。

安装模板

1. 安装SSW净架构模板：

dotnet new install HeroApi.Template

注意：模板只需安装一次，默认情况下会自动更新到最新版本。

2. 创建新目录：

mkdir Northwind365
cd Northwind365

3. 创建新解决方案：

dotnet new ssw-ca

注意：name参数是可选的，如果没有指定，默认使用目录名作为解决方案名称和项目命名空间。

添加功能模块

1. 添加查询功能：

cd src/Application/Features
mkdir {{FeatureName}}
cd {{FeatureName}}
dotnet new ssw-ca-query --name {{QueryName}} --entityName {{Entity}} --slnName {{SolutionName}}

2. 添加命令功能：

cd src/Application/Features
mkdir {{FeatureName}}
cd {{FeatureName}}
dotnet new ssw-ca-command --name {{CommandName}} --entityName {{Entity}} --slnName {{SolutionName}}

运行解决方案

1. 切换目录到工具目录：

   Windows:

   cd tools\AppHost\
   

   Mac/Linux:

   cd tools/AppHost/
   

2. 运行项目：

   dotnet run
   

注意：首次运行时，可能会花费几分钟时间下载Docker镜像、创建数据库并初始化数据。

3. 打开浏览器访问： https://localhost:7255/scalar/v1

发布模板

当对CleanArchitecture.nuspec文件的主分支进行修改时，模板将自动发布到NuGet.org。

发布流程

1. 更新CleanArchitecture.nuspec文件中的version属性。
2. 合并代码提交。
3. GitHub Actions会自动运行package工作流并发布新版本到NuGet.org。
4. 创建GitHub发行版以记录更新内容。

注意：我们采用CalVer版本号格式，如YYYY.M.D（例如2024.2.12）。

学习资源

培训课程

如果您想深入了解SSW净架构，可以参加以下活动：

• SSW 一日净架构超级能力巡讲
• SSW 两日净架构工作坊

学习资料

推荐以下视频学习净架构知识：

• Clean Architecture with ASP.NET Core and MAUI

此外，您还可以参考以下资源链接：

• .NET 开发文档
• SSW官方文档

贡献与支持

如需贡献代码或提出问题，请访问我们的GitHub仓库。

许可证

本项目遵循MIT License协议。