前言
通常在測試 API 的工具中，Postman 或 Insomnia 都是很方便的 API 測試圖形介面工具。
只是各工具有各自的保留文件格式，若能把測試 API 的資料文件化並做版控，又能夠減少散落在各處的翻查不易的問題。
因為 Visual Studio 2022 已支援能夠在 IDE 開啟 .http 文件，並直接可做測試看結果，而且功能齊全，文字檔案又能做版控。
但筆者不是只有 .NET 的專案，還有其他程式語言的專案，也會使用 Visual Studio Code 來撰寫，所以若能讓 .http 文件能跨專案跨工具來執行並管理就更棒了。
在本文中分別介紹在 Visual Studio 2022 及 Visual Studio Code 如何使用 .http 來執行測試 RESTful API。
環境
- Visual Studio 2022 (v17.8.6)
- Visual Studio Code (v1.86.1) + REST Client (by Huachao Mao)
.http 文件
本範例是在 Visual Studio 2022 建立一個 ASP.NET Core Web API 預設基本專案
單純只有一個 WeatherForecast 的 GET 方法
.http 範例 (檔案: WeatherForecast.http)
# Basic GET request
GET https://localhost:7147/WeatherForecast
###
# Setup dynamic variables
@hostname=localhost
@port=7147
@host={{hostname}}:{{port}}
GET https://{{host}}/WeatherForecast
Accept: application/json
Visual Studio 2022
在 Visual Studio 2022 的執行結果很豐富
- Formatted 格式化回應資料
- Raw 原始回應資料
- Headers 標頭資訊
- Request 要求資訊
Visual Studio Code
在 Visual Studio Code 需要安裝套件: REST Client
一樣可以執行顯示結果，只是相較下沒那麼豐富
參考資料
- 在 Visual Studio 2022 中使用 .http 檔案
- New .http file support in Visual Studio 2022
- RFC 9110 HTTP Semantics
在除夕這天還是寫了篇文章，祝大家龍年行大運啦！ Happy Chinese New Year~
