ASP.NET Core 2.2 WebApi 系列【一】搭建ASP.NET Core WebApi項目

一、步驟

從“文件”菜單中選擇“新建”>“項目” 。

選擇“ASP.NET Core Web 應用程序”模板，再單擊“下一步” 。

將項目命名為 NetCoreWebApi，然后單擊“創建” 。

選擇“.NET Core”和“ASP.NET Core 2.2” 。 選擇“API”模板，然后單擊“創建” 。

創建完成后，項目結構如下：

二、項目解讀

Properties——launchSettings.json

啟動配置文件，一個ASP.NET Core應用保存特有的配置標准，用於應用的啟動准備工作，包括環境變量，開發端口等。

{
  "$schema": "http://json.schemastore.org/launchsettings.json",
  "iisSettings": { //選擇以IIS Express啟動 
    "windowsAuthentication": false, //是否啟用windows身份驗證
    "anonymousAuthentication": true, //是否啟用匿名身份驗證
    "iisExpress": {
      "applicationUrl": "http://localhost:60953", //IIS Express隨機端口
      "sslPort": 0
    }
  },
  "profiles": {
    "IIS Express": {
      "commandName": "IISExpress",
      "launchBrowser": true, //是否在瀏覽器中啟動
      "launchUrl": "api/values", //在瀏覽器中啟動的相對URL
      "environmentVariables": { //將環境變量設置為鍵/值對
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    },
    "NetCoreWebApi": {
      "commandName": "Project",
      "launchBrowser": true,
      "launchUrl": "api/values",
      "applicationUrl": "http://localhost:5000",
      "environmentVariables": {
        "ASPNETCORE_ENVIRONMENT": "Development"
      }
    }
  }
}

appsetting.json

appsetting.json是應用程序配置文件，類似於ASP.NET MVC應用程序中的Web.config配置文件。

例如：連接字符串，等等....

{
    "Logging":{
        "LogLevel":{
            "Default":"Warning"
        }
    },
    "AllowedHosts":"*",
    "ConnectionStrings":{
        "SqlServer":"Data Source=.;Initial Catalog=NetCoreWebApi;User Id=sa;Password=123;"
    }
}

Program.cs

Program.cs文件是應用的入口, 啟動后通過UseStartup<Startup>()指定下文的Startup啟動文件進行啟動。

 public class Program
    {
        public static void Main(string[] args)
        {
            CreateWebHostBuilder(args).Build().Run();
        }

        public static IWebHostBuilder CreateWebHostBuilder(string[] args) =>
            WebHost.CreateDefaultBuilder(args)//創建WebHostBuilder。
                .UseStartup<Startup>();//指定啟動類，用於依賴注入和中間件注冊。
    }

Startup.cs

該文件是默認文件，不可隨意刪除，在此文件中可以以包含服務配置、定義請求處理管道的重要操作。

ConfigureServices 方法用於將服務注入到 IServiceCollection 服務容器中。

Configure方法用於應用響應 HTTP 請求，將中間件注冊到 ApplicationBuilder中來配置請求管道。

 public class Startup
    {
        public Startup(IConfiguration configuration)
        {
            Configuration = configuration;
        }

        public IConfiguration Configuration { get; }

        //負責注入服務
        public void ConfigureServices(IServiceCollection services)
        {
            services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Version_2_2);
        }

        // 響應 HTTP 請求的方式。可將中間件注冊到IApplicationBuilder 實例來配置請求管道。
        public void Configure(IApplicationBuilder app, IHostingEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }

            app.UseMvc();
        }
    }

三、測試

此時項目已經完成，按 Ctrl+F5 運行之后，就能看到 

​

這是一個最基礎的.NET Core API 環境，離我們想要的API框架還很遠，但是其實已經成功一半了，因為好的開始是成功的一半！​​