iT邦幫忙

2022 iThome 鐵人賽

DAY 18
0
Software Development

語言只是工具,遊走在需求和技術間的腦力激盪之旅系列 第 18

Day 18 - Case 3 :Web Api開發起手式(.NET 6 Web Api)

  • 分享至 

  • xImage
  •  

今天的內容會逐步帶大家從開發環境設定到建立一個API的過程,並且補充一些開發過程中可以參考的資源,接著就來進入開發Api的世界吧!

開發的工具與專案建立

Visual Studio Code

在選擇上如果已經習慣使用VSCODE開發可以參考dotnet的相關指令,可以參考這個dotnet new < TEMPLATE>的說明文件檢視如何建立Web Api的範本,接著簡單說明一下這個指令可以怎麼應用。

首先可以先檢查當前開發的電腦是否有確實安裝.NET 6 SDK,開啟PowerShell之後輸入dotnet或者是dotnet --version,有安裝成功的話可以看到安裝的版本資訊與其他指令提示。
Imgur

輸入donte new --list檢視可以建立的範本清單,接著檢視簡單名稱的欄位,這些都是在建立範本時需要對應輸入的簡寫,所以如果需要建立web api的範本時可以輸入dotnet new webapi,接著就可以看到範本成功新增到當前執行的資料夾(如果需要指定其他位置可以參考下下圖)。
Imgur

dotnet new webapi
-- 如果建立的時候需要指定目錄可以在後面加入 -o|--output <OUTPUT_DIRECTORY>

Visual Studio (2022)

相較於Visual Studio Code需要透過指定的方式建立,Visual Studio可以直接透過GUI的方式完成範本建立的動作,但如果習慣指令的做法也可以到到Visual Studio內,使用quick search或者是選單的方式開啟PowerShell。
Imgur
Imgur
Imgur
Imgur
Imgur

這時候在這裡停一下檢視Use Controller (uncheck to use minimal APIs) 和 Do not use top-level statements的選項,這兩個項目為.NET 6版本的關聯設定做個簡單的說明。

Use Controller (uncheck to use minimal APIs)

在.NET 6之後新增了Minimal APIs的開發形式,如果當前開發的需求只是想要快速產生API,並且功能沒有到很複雜的時候可以取消勾選use controllers。

Do not use top-level statements

top-level statements也是NET 6推出的語法架構,從教學課程:探索使用最上層語句在學習時建置程式碼的想法的來源可以知道開啟後的差異點,top-level statements的用意在於可以專注開發當下的功能,並且在做程式碼重構時為更容易維護(但還是要取決怎麼重構xD)。


// not use top-level statements
using System;

namespace Application
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("Hello World!");
        }
    }
}

// use top-level statements
// See https://aka.ms/new-console-template for more information
Console.WriteLine("Hello, World!");

當環境都初步建立好之後接著可以參考官方提供的Tutorial: Create a minimal web API with ASP.NET Core,初步了解Api各種行為的設計方式,其他可以延伸的資訊和參考做法會在明天進一步分享。


上一篇
Day 17 - Case 3 :多個系統間溝通篇(需求評估與解決方法)
下一篇
Day 19 - Case 3 :紀錄Api的一舉一動(.NET 6 Web Api Logging)
系列文
語言只是工具,遊走在需求和技術間的腦力激盪之旅30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言