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應用程序，這種項目結構似乎有點過大，但是該結構在這裡顯示出一種處理較大項目的代碼結構的方法。代碼結構應能夠處理具有大量代碼和功能的較大系統。
將模板保留為“整體化”，因為我認為這可能是啟動新項目的最佳方法。在這裡閱讀更多
被認為，但是如果有更好的方法，我一直認為準備改變任何東西