ASP.NET Core Web API 模板指南

谢媛露Trevor

于 2024-09-16 07:35:19 发布

阅读量987

点赞数 27

本文链接：https://blog.csdn.net/gitblog_01067/article/details/142295190

版权

ASP.NET Core Web API 模板指南

aspnetcore-webapi-template This project is an Web API Open-Source Boilerplate Template that includes ASP.NET Core 5, Web API standards, clean n-tier architecture, GraphQL service, Redis, Mssql, Mongo databases and User Auditing (Identity) with a lot of best practices. 项目地址: https://gitcode.com/gh_mirrors/as/aspnetcore-webapi-template

本指南将带您深入了解 sinantok/aspnetcore-webapi-template，一个基于ASP.NET Core 5的开放源代码Web API脚手架模板。它融合了清洁的N层架构、GraphQL服务、Redis缓存、SQL Server（Mssql）、MongoDB数据库以及用户审计功能，并遵循最佳实践。

1. 项目目录结构及介绍

该模板采用了一种组织良好的目录结构，旨在促进可维护性和清晰性：

src: 主要的源代码存放位置。
- Application: 包含业务逻辑层代码，如服务和应用层实体。
- Domain: 定义领域模型和核心业务规则。
- Infrastructure: 存储数据访问层(DAL)代码，包括Entity Framework上下文和仓储实现。
- Presentation: 包括Web API端点和服务接口，即控制器所在的位置。
- SharedKernel: 共享的非领域特定逻辑，例如响应包装器或自定义异常处理程序。
Config: 可能包含环境相关的配置文件，尽管主要配置通常在appsettings.json及其环境特定变体中定义。
Tests: 单元测试和集成测试目录，确保应用的健壮性。
Data: 数据库初始化脚本或相关数据操作工具可能存放于此。
docs: 如果存在，可能会有额外的文档资源。
appsettings.json 和 appsettings.{Environment}.json: 配置文件，用于设置如数据库连接字符串等关键信息。
Startup.cs: 启动文件，负责配置应用程序的服务、中间件和管道。

2. 项目的启动文件介绍

Startup.cs

ConfigureServices(IServiceCollection services) 方法中注册所有依赖服务，包括数据库上下文、服务、中间件、JWT认证、Swagger配置等。
Configure(IApplicationBuilder app, IWebHostEnvironment env) 方法配置HTTP请求管道，包括使用Kestrel服务器、添加中间件（如日志、错误处理、静态文件支持）、路由设置及启用SwaggerUI等。

3. 项目的配置文件介绍

appsettings.json

该文件是主要的配置存储中心，包含以下关键部分：

ConnectionStrings: 列出了不同数据库连接字符串，比如默认连接（DefaultConnection）和身份验证连接（IdentityConnection），涉及SQL Server和MongoDB等。
Logging: 定义日志记录级别和输出目标。
AppSettings: 应用特定的设置，如API的运行时行为调整。
Swagger: 配置Swagger UI的相关选项，便于API文档化和测试。

appsettings.Development.json, appsettings.Production.json

这些文件提供环境特定的配置覆盖，允许在不同的部署环境下有不同的设置，比如开发环境的日志级别更详细，而生产环境中则更加严格。

使用步骤简述

克隆仓库: git clone https://github.com/sinantok/aspnetcore-webapi-template.git
安装依赖: 在项目根目录下运行 dotnet restore.
更新数据库: 运行迁移命令，例如 dotnet ef database update -Context IdentityContext 和 dotnet ef database update -Context ApplicationDbContext.
修改配置: 根据实际环境更改appsettings.json中的连接字符串。
启动应用: 使用 dotnet run 或通过Visual Studio启动解决方案。
访问API: 通过Swagger UI（通常位于http://localhost:[port]/swagger）来浏览和测试你的API端点。