dotnet-api-boilerplate

项目简介

dotnet-api-boilerplate是一个基于.Net 8.0的WebApi模板项目，其主要目的是为开发者提供一个快速启动的框架。该项目集成了一些常用的技术和设计模式，包括MediatR、Swagger、Mapster、Serilog等，旨在通过提供一套标准化的基础建设，使你的RESTful API开发工作变得更简单快捷。

项目特点

该项目涵盖多个重要的开发特性：

• SwaggerUI：用于API文档生成和展示。
• EntityFramework和Postgres：用于数据库操作。
• MediatR：用于中介者模式。
• Mapster：替代AutoMapper，用于对象映射。
• 日志管理：使用Serilog实现请求日志记录，并且可以轻松配置不同的日志输出方式。
• 性能优化：包括响应压缩和分页。
• 认证和授权：内置身份验证和授权机制。
• 测试支持：提供单元测试和基于容器的集成测试。
• 容器化支持：通过Docker和Docker Compose轻松搭建容器环境。
• CI/CD 集成：通过Github Actions实现持续集成。
• OpenTelemetry支持：提供默认的OLTP导出器。
• 其他：例如NuGet中央包管理、资源过滤和强类型ID等。

项目运行

单独运行

1. 你需要一个运行中的Postgres实例，初始化适当的迁移。可以使用Docker来运行数据库，命令为：docker-compose up -d db-server。
2. 进入src/Boilerplate.Api目录，运行命令dotnet run，或者在Visual Studio中将API项目设为启动项目，并以控制台、Docker或IIS模式运行。
3. 在浏览器访问http://localhost:7122/api-docs或https://localhost:7123/api-docs查看Swagger文档。

Docker方式

1. 在项目根目录运行命令docker-compose up -d，会启动应用及数据库。需要注意的是运行此命令前需生成HTTPS证书。
2. 同样可以通过访问http://localhost:7122/api-docs或https://localhost:7123/api-docs来查看API接口文档。

测试运行

在项目根目录执行dotnet test命令，这将寻找所有与解决方案文件相关联的测试项目。如果使用Visual Studio，可以通过测试菜单运行测试。

项目结构

• Services：存储所有的API及对用户提供数据的组件。
  • Boilerplate.Api：主要API项目，包含所有的控制器和初始化配置。
  • docker-compose：允许在Visual Studio中运行docker-compose的配置。
• Application：处理API与领域层之间的数据转换以及业务逻辑。
  • Auth：包含登录会话实现。
• Domain：业务模型、枚举和通用接口。
  • Boilerplate.Domain：业务模型和枚举。
• Infra：所有数据访问配置和数据库上下文。
  • Boilerplate.Infrastructure：包含数据库上下文、实体配置和迁移。

如何应用于你的项目

1. 删除或重命名与项目无关的内容。
2. 根据需求重命名解决方案、项目、命名空间和规则集。
3. 修改Dockerfile和docker-compose.yml以适应新的项目目录结构。
4. 如果你喜欢这个项目，不妨给个星星支持一下！

迁移支持

需要安装dotnet-ef工具来运行迁移。

• 运行命令：dotnet tool install --global dotnet-ef
• 根据操作系统运行不同的迁移命令。

致谢

该项目受到netcore-boilerplate和EquinoxProject的极大影响。

关于

该模板由Yan Pitangui开发，并遵循MIT许可协议。