asp.net core web api model naming rule coding style appsettings visual studio code restful api

ASP.NET Core 5 EP 3:Web API專案的檔案結構

類似MVC架構下的檔案結構

ASP.NET Core Web API專案結構依循ASP.NET Core MVC專案而來,但不同的是,Web API專案僅專注在Model(模型)與Controller(控制器),並不特別探討View(視圖)的部分,簡單說,Web API在意的是資料與邏輯,至於畫面的呈現或美觀與否就不在開發時的考量之內了!

當專案初始建置時,會得到一包簡單的檔案,如下圖:

  1. bin:編譯後執行檔放置的地方。
  2. Controllers:控制器,API的程式。
  3. appsettings.Development.json:開發環境設定檔。
  4. appsettings.json:正式環境設定檔。
  5. CookbookApi.csproj:專案設定檔,包含了關聯檔案、參考套件等資訊。
  6. Program.cs:Main()的所在地。
  7. Startup.cs:應用程式的進入點,
  8. WeatherForecast.cs:範例,可以刪掉。

Web API把多餘的去除

在剛建立的專案中,有兩個檔案是範本裡自帶的,這兩個檔案算是範例,如下:

  1. Controllers/WeatherForecastController.cs
  2. WeatherForecast.cs

我們並不需要這兩個檔案,不刪除,就是成為專案中永遠執行不到的垃圾檔案,所以請放心的刪除他們!

補足缺少的

寫程式時,乾淨的檔案結構有利於工程師高效率的寫作,基於日後的需要,我們在專案的根目錄加上幾個新的資料夾,如下:

  1. Assets:將圖片、檔案…等放置於此備用。
  2. Commons:通用類的程式碼。
  3. Libs:領域/邏輯/計算類的程式碼。
  4. Models:資料模型。

~ END ~


,

Related posts

Latest posts