Maui Blazor 中文社区 QQ群:645660665

使用 Visual Studio 2022 的 .http 文件方式调试 API

参考资料 https://learn.microsoft.com/zh-cn/aspnet/core/test/http-files?view=aspnetcore-8.0

在没有Postman等专门软件环境下, 有没有轻量的调试http方法呢?尤其是每天都要打开宇宙第一IDE的环境, 其实VS本身就带了一种方式, 就是创建一个http文件来完成这个工作.

Visual Studio 2022 .http 文件编辑器提供了一种便捷的方式来测试 ASP.NET Core项目,尤其是 API 应用。 编辑器提供一个 UI,用于:

  • 创建和更新 .http 文件。
  • 发送 .http 文件中指定的 HTTP 请求。
  • 显示响应。

HTTP 请求的格式为 HTTPMethod URL HTTPVersion,全部在一行上,其中:

HTTPMethod 是要使用的 HTTP 方法,例如:

  • OPTIONS
  • GET
  • HEAD
  • POST
  • PUT
  • PATCH
  • DELETE
  • TRACE
  • CONNECT

URL 是向其发送请求的 URL。 此 URL 可以包括查询字符串参数。 此 URL 不必指向本地 Web 项目。 它可以指向 Visual Studio 可以访问的任何 URL。
HTTPVersion 是可选的,指定应使用的 HTTP 版本,即 HTTP/1.1、HTTP/2 或 HTTP/3。

通过使用行 ### 作为分隔符,文件可以包含多个请求。 以下示例在一个文件中显示了三个请求,说明了此语法:

GET https://localhost:7220/weatherforecast

###

GET https://localhost:7220/weatherforecast?date=2023-05-11&location=98006

###

GET https://localhost:7220/weatherforecast HTTP/3

###

请求正文
在空白行后面添加请求正文,如以下示例所示:

POST https://localhost:7220/weatherforecast
Content-Type: application/json
Accept-Language: en-US,en;q=0.5

{
    "date": "2023-05-10",
    "temperatureC": 30,
    "summary": "Warm"
}

###

变量
以 @ 开头的行使用语法 @VariableName=Value 定义变量。

可以在稍后在文件中定义的请求中引用变量。 通过用双大括号括起名称 {{ 和 }} 来引用它们。 以下示例演示在请求中定义和使用的两个变量:

@hostname=localhost
@port=44320
GET https://{{hostname}}:{{port}}/weatherforecast

可以使用文件前面定义的其他变量的值来定义变量。 以下示例在请求中使用一个变量,而不是前面示例中所示的两个变量:

@hostname=localhost
@port=44320
@host={{hostname}}:{{port}}
GET https://{{host}}/api/search/tool

是不是轻便又简单, 更多用法大家参考官方文档, 这里只是简单摘抄记录一下

官方文档 https://learn.microsoft.com/zh-cn/aspnet/core/test/http-files?view=aspnetcore-8.0

posted @ 2024-03-08 18:16  AlexChow  阅读(831)  评论(0编辑  收藏  举报