MyWebAPITemplate下载MyWebAPITemplate源代码下载

MyWebAPITemplate

其他类别

1.0.0

下载

我的网络API模板

具有ASP.NET Core的各种REST API的入门模板

这是我自以为是的，不断地正在进行的，开头模板，用于构建REST API。

如果您只想开始编码，想要一个已经经过深思熟虑的项目结构，这是非常简单且快速学习的，并且可以在较小和较大的项目上工作，则此模板适合您。

细节

技术，框架和图书馆

编程语言：C＃
框架：ASP.NET Core 7（始终是最新版本）
数据库：SQL Server（也可以使用其他数据库）
ORM：实体框架
测试：Xunit，ior＆fluentassertions

建筑，功能和模式

模板文件夹结构

 app                               -> App and related files
 ├─> src                          -> App source
 │   ├─> Web                      -> Entry point for API - runnable project
 │   │   ├─> Controllers          -> API endpoints
 │   │   ├─> Extensions           -> Extension methods
 │   │   ├─> Interfaces           -> Web project's interfaces
 │   │   ├─> Mappers              -> Model mappers
 │   │   ├─> Middlewares          -> Middlewares (e.g. global error handling)
 │   │   |─> Models               -> Models in and out of API
 │   │   ├─> Settings             -> Options pattern for App (e.g. connection strings)
 │   │   ├─> Validators           -> Model validation rules
 │   │   ├── Program.cs           -> START
 │   │   └── Startup.cs           -> START
 │   ├─> Core                     -> Holds business logic
 │   │   ├─> Dtos                 -> Data-transfer-object (used for business logic)
 │   │   ├─> Entities             -> Entity Framework entities for database 
 │   │   ├─> Interfaces           -> Core project's interfaces
 │   │   ├─> Mappers              -> Dto and Entity mappers
 │   │   ├─> Services             -> Business logic services
 │   └─> Infrastructure           -> Data access and external services 
 │       ├─> Database             -> Database access
 │       │   ├─> Configurations   -> Entity Framework table configurations
 │       │   ├─> Migrations       -> Entity Framework autogenerated migrations
 │       │   ├─> Repositories     -> Repository pattern
 │       │   ├── AppDbContext.cs  -> Base context
 │       │   ├── AppSeed.cs       -> Database seeding
 │       │   └── EfRepository.cs  -> Base repository
 │       └─> ExternalServices     -> Services that access external services (e.g. ext. email service)
 └─> tests                        -> App tests
     ├── FunctionalTests          -> Endpoint tests etc.
     │   ├─> Tests                -> All tests
     │   └─> Utils                -> Utility functions (e.g. test database setup)
     ├── IntegrationTests         -> Database tests etc.
     │   ├─> Tests                -> All tests
     │   ├─> Utils                -> Utilities functions (e.g. test database setup)
     ├── UnitTests                -> Application logic tests etc.  
     │   ├─> Tests                -> All tests
     │   ├─> Utils                -> Utility functions 
     └── Shared                   -> Model builders and other shared functions for tests

用法

在窗户上

下载最新的.NET SDK（https://dotnet.microsoft.com/download）

第一次运行时 - 初始化数据库

 dotnet tool install --global dotnet-ef
dotnet ef database update -c ApplicationDbContext -p . /src/Infrastructure/Infrastructure.csproj -s . /src/Web/Web.csproj

发射
- 选项1。在Visual Studio上启动
  1. 使用MyWebAPITemplate.sln打开
  2. 按F5或Debug/Start Debugging
- 选项2。在CLI上启动
  1. ```
   dotnet run -p . /src/Web/
```
导航到https：// localhost：5001/swagger/index.html

与Docker跨平台（正在进行中）

目前仅使用内存

新的数据库迁移

当您需要创建新的迁移（更改数据库架构时）时，请运行此命令以告诉实体框架以处理数据库所需的架构更改。

 dotnet ef migrations add NewMigrationNameHere --context ApplicationDbContext -p . /src/Infrastructure/Infrastructure.csproj -s . /src/Web/Web.csproj -o Database /Migrations

动机

该项目始于我处理以单一整体方式构建API时需要完成的一切信息流的方式。有很多事情要记住，还有很多选择。因此，我为自己制作了这个模板，以存储我发现实用的所有实践，我希望这个模板也可以帮助别人学习一两个东西。

在此模板中，我以实用格式收集了对API构建的知识。根据最佳实践，受欢迎程度和我自己的偏好，做出了建筑偏好，图书馆选择和其他选择。该模板的目的是提供一个很好的基本示例，介绍如何使用可扩展，易于使用的ASP.NET构建REST API，并包含必要的配置和其他好处。该模板的灵感来自Microsoft Eshoponweb参考应用程序和许多其他模板。

目标

每当我发现有用的东西时，要改善模板，或者我想出一种处理程序的某些部分的新方法。
仅使用我以前一些项目中已经使用过的概念或技术，所以我知道这些是否值得。这个项目不是为了修补所有实验内容，还有其他项目:)
保持结构简单，但不太简单。对于TODO应用程序，这种项目结构似乎有点过大，但是该结构在这里显示出一种处理较大项目的代码结构的方法。代码结构应能够处理具有大量代码和功能的较大系统。
将模板保留为“整体化”，因为我认为这可能是启动新项目的最佳方法。在这里阅读更多
被认为，但是如果有更好的方法，我一直认为准备改变任何东西