以前寫過ASP.NET Core 2.x的REST API文章，今年再更新一下到3.0版本，

先決條件

我在B站有一個非常入門的ASP.NET Core 3.0的視頻教程，如果您對ASP.NET Core不了解，就可以先看一下里面的基礎知識和API相關的內容，地址是：https://www.bilibili.com/video/av65313713/，

預備知識：ASP.NET Core 和 C#

工具：Visual Studio 2019最新版（VSCode、VS for Mac，Rider等也湊合），POSTMAN

Web API

Web API通常是指“使用HTTP協議并通過網路呼叫的API”，由于它使用了HTTP協議，所以需要通過URI資訊來指定端點，

API是Application Programming Interface的縮寫，是軟體的外部介面，也就是說，針對某個軟體，人們可以知道它的外部功能，但并不知道（也不需要知道）它的內部運作細節，為了從外部呼叫某些功能，需要指定軟體的呼叫規范等資訊，這樣的規范就是API，

所以Web API就是一個Web系統，通過訪問URI可以與其進行資訊互動，

大多數的 Web API 并不是 RESTful API

REST一詞是在2000年首次出現的，它是由Roy Fielding博士在《架構風格以及基于網路的軟體架構設計》這篇論文中提到的，他為REST風格的API制定了一套約束規范或者叫架構風格，

所以準確的說，只有符合了Roy Fielding架構風格的Web API才能稱作是RESTful API，但是在實際開發中，有時候也有不完全符合Roy Fielding架構風格的情形出現，針對這點我將會在稍后的文章中介紹，

MVC模式與RESTful API

本系列文章中我將使用ASP.NET Core 3.0 MVC 來構建 RESTful API，

MVC（Model-View-Controller）我認為是一種主要用來構建UI的架構模式，對于MVC模式其實有很多種解釋存在，但是無論那種解釋，它們都會強調松耦合和關注點分離（separation of concerns），

也是由于這兩點的存在，程式的可測驗性會大大提高，程式各部分的可復用性也很高，

更多關于MVC的介紹，可以看一下微軟的官方檔案：https://docs.microsoft.com/zh-cn/aspnet/core/mvc/overview?view=aspnetcore-3.0

注意：MVC不是一個完整的應用程式架構，我認為它主要是用在展示層，所以實作UI就是MVC的一部分作業，

如何把MVC映射到API

我認為API同樣可以看作是UI，它就是為API消費者所提供的UI，

讓我們把MVC的三部分分別對應到API：

Model，它負責處理程式資料的邏輯，這里的Model可以包含在當前級別獲取從存盤獲取資料的邏輯，但是有一些Model不包含任何邏輯，例如API所使用的DTO（Data transfer objects），這類的Model會被串行化到回應的body里面，
View，它是程式里負責展示資料的那部分，在構建API的時候，View就是資料或資源的展示，現在通常使用JSON格式，
Controller，它負責View和Model之間的互動，包括處理用戶輸入，用API的術語來講，和API互動的“用戶”就是指API的消費者，這類用戶通常是另一個程式，例如Angular的SPA程式，

下面看看MVC這三部分的依賴關系：

Controller和View依賴于Model，Controller依賴于View，這也是分離的一個好處，

換句話說，Controller會選取適當的View來展現給用戶，并一同把用戶請求的Model資料帶回去，

當API消費者發出請求的時候，在Controller上面的Action將會被觸發，Controller會把接收到的輸入資料發送給負責業務處理邏輯或資料訪問邏輯的那部分程式，然后Controller會把Model回傳給View，這里的View就是資源的展示（通常是JSON格式），

接下來我們就是用這套概念和ASP.NET Core 3.0 來創建RESTful API，

但是請注意，通過ASP.NET Core MVC或API模板建立出來的新專案，我們并不會直接得到RESTful（REST架構風格）的API，我們必須在這個基礎上，自己構建RESTful的API，因為之前已經提到了，標準的RESTful API有很多約束和規范，

創建ASP.NET Core 3.0 Web API專案

打開VS2019，選擇專案模板ASP.NET Core Web Application：

Create a new project Recent project templates gRPC Service •3 ASP.NET Core Web Application Console App (.NET Framework) Windows Forms App (.NET Framework) Search for templates (Alt+S) All Platforms Console App (.NET Core) Clear All Project Types A project for creating a comman ne application that can n_ln on .NET Core on Windows, Linux and MacOS. Linux macOS dows Console ASP.NET Core Web Application ject templates for creating ASP.NET Core web apps and web APIs for Windows, Linux and macOS using .NET Core or .NET Framework. Create web apps with Razor Pages, MVC, or Single Page Apps (SPA) using Angular, React, or React * Redux. ma cas 81azor App Windows Coud Semi ce Web n Project templates for creating Blazor apps that that run on the server in an ASP.NET Core app or in the browser on WebAssembIy. These templates can be used to build web apps with rich dynamic user interfaces (UIs). Linux macOS Windcms Coud Web Class Library (.NET Standard) A project for creating a class library that targets .NET Standard. C# Android iOS Azure Functions Linux macOS Windcms ibrary A template to create an Azure Function project. Azure Coud

然后為專案和解決方案起名字，并選擇所在目錄：

Configure your new project ASP.NET Core Web Application L Inux Project name Routine.Api Location o Solution name Routine Place solution and project in the same directory macOS Windcwvs Coud Service Web

然后選擇ASP.NET Core的專案模板：

Create a .NET Core Empty An empty new ASP.NET Core web application ASP .NET 3.0 ect template for creating an ASP .NET Core application. This template does not have any content in it. A project template for creating an ASP .NET Core application with an example Controller for a RESIfuI HITP service. This template can also be used for ASP .NET Core MVC Views and Controllers. Web Application A project template for creating an ASP NET Core application with example ASP NET Razor Pages content. Web Application (Model-View-Controller) A project template for creating an ASP .NET Core application with example ASP .NET Core MVC Views and Controllers. This template can also be used for RESIfuI HITP services. o Angular A project template for creating an ASP .NET Core application with Angular React.js A project template for creating an ASP NET Core application with React.js Get additional project templates Authentication No Authentication Change Adv ced Configure for HITPS Enable Docker Support (Requires Docker Desktop) Linux Author: Microsoft Source: .NET Core 3.010 Create

首先要選擇ASP.NET Core 3.0，

這里我選擇了API這個模板，在以前，我通常會選擇Empty模板，因為其它模板通常包含很多我不需要的東西，但是ASP.NET Core 3.0的API模板還是比較干凈的，可以接受，

最后，由于本課程中不需要使用HTTPS和Docker，所以把這兩個東西都勾掉，

解剖 ASP.NET Core 3.0 API 模板專案

點擊Create，專案就建立好了：

Solution 'Routine' (I of I project) Routine-Api Connected Services Dependencies Analyzers •@ Frameworks properties launchSettingsjson Controllers c* WeatherForecastControIIer.cs appsettingsjson C" C" C" appsettings.DeveIopmentjson Program.cs Startup.cs WeatherForecast.cs

先看看 appsettings.json：

Routine.Api appsettings.json -E X Schema: http://json.schemastore.org/appsettings 2 8' "Logging" • "LogLevel": "Default": "Information" , 4 "Microsoft": "Warning", 5 "Microsoft. Hosting. Lifetime": "Information" 6 7 8 "AllowedHosts": 9 10 11

里面只有默認的Log配置以及允許的Hosts，

而appsettings.Development.json里面：

appsettings.json appsettings.DeveIopment.json -E X Schema: http://json.schemastore.org/appsettings 2 8' "Logging" • "LogLevel": "Default": Routine.Api 4 5 6 7 8 9 10 "Debug" , "System": "Information" , "Microsoft": "Information"

也只有關于Log的默認配置，

注意：您需要知道appsettings.json 和 appsettings.Development.json之間的關系，關于這點可以看我ASP.NET Core 3.0的入門視頻教程，但是更簡單的辦法是看一下官方檔案：在ASP.NET Core中使用多個環境，

專案模板里還有兩個類我們不需要，所以把它刪掉，分別是WeatherForecastController和WeatherForecast：

Routine.Api C" C" C" Connected Services Dependencies Analyzers •@ Frameworks Properties launchSettingsjson Controllers C* WeatherForecastControIIer.cs appsettings.json appsettings.DeveIopmentjson Program.cs Startup.cs Weather Forecast.cs

Program.cs：

public class Program public static void Main(stringC] args) CreateHostBuilder(args) . Build( ) . Run( ) ; public static IHostBuilder CreateHostBuilder(string[] args) Host. CreateDefaultBuilder(args) . ConfigureWebHostDefaults(webBuilder webBuilder . ) ; D;

這里其實就是整個程式的入口，Main方法負責配置和運行整個Web程式，

由于這是一個Web專案，所以我們還需要一個宿主（Host），這個宿主就是由下面的CreateHostBuilder方法來負責創建的，該方法首先會創建出一個實作了IHostBuilder介面的類（HostBuilder）的實體，然后呼叫它的Build方法來創建宿主（型別為Host，實作了IHost介面），最后呼叫宿主上面的Run方法來運行程式，

我們暫時不修改這里面的代碼，所以一切都會按照專案模板默認的配置進行，注意到下面的方法里我們使用到了Startup這個類：