使用 Visual Studio 2022 中的 .http 文件 |
您所在的位置：网站首页 › 创建一个test目录 › 使用 Visual Studio 2022 中的 .http 文件 |
使用 Visual Studio 2022 中的 .http 文件
|
使用 Visual Studio 2022 中的 .http 文件
项目
05/16/2023
Visual Studio 2022.http 文件编辑器提供了一种便捷的方式来测试 ASP.NET Core项目，尤其是 API 应用。 编辑器提供一个 UI，用于： 创建和更新 .http 文件。 发送 .http 文件中指定的 HTTP 请求。 显示响应。本文包含以下文档： .http 文件语法。 如何使用 .http 文件编辑器。 如何使用 Visual Studio 2022 终结点资源管理器在 .http 文件中创建请求。.http 文件格式和编辑器受 Visual Studio Code REST 客户端扩展的启发。 Visual Studio 2022 .http 编辑器将 .rest 识别为相同文件格式的替代文件扩展名。 先决条件 安装了 Visual Studio 2022 版本 17.6 预览版 6 或更高版本，以及 ASP.NET 和 Web 开发工作负载。 .http 文件语法以下部分介绍 .http 文件语法。 注释以 # 或 // 开头的行是注释。 当 Visual Studio 发送 HTTP 请求时，将忽略这些行。 变量以 @ 开头的行使用语法 @VariableName=Value 定义变量。 可以在稍后在文件中定义的请求中引用变量。 通过用双大括号 {{ 和 }} 将名称包装起来来引用它们。 以下示例演示在请求中定义和使用的两个变量： @hostname=localhost @port=44320 GET https://{{hostname}}:{{port}}/weatherforecast可以使用文件前面定义的其他变量的值来定义变量。 以下示例在请求中使用一个变量，而不是前面示例中所示的两个变量： @hostname=localhost @port=44320 @host={{hostname}}:{{port}} GET https://{{host}}/api/search/tool 请求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。通过使用行 ### 作为分隔符，文件可以包含多个请求。 以下示例在一个文件中显示了 3 个请求，说明了此语法： GET https://localhost:7220/weatherforecast ### GET https://localhost:7220/weatherforecast?date=2023-05-11&location=98006 ### GET https://localhost:7220/weatherforecast HTTP/3 ### 请求标头若要添加一个或多个标头，请将每个标头立即添加到请求行后其自己的行中。 不要在请求行与第一个标头之间或后续标头行之间包含任何空白行。 格式为 HeaderName: Value，如以下示例所示： GET https://localhost:7220/weatherforecast Date: Wed, 27 Apr 2023 07:28:00 GMT ### GET https://localhost:7220/weatherforecast Cache-Control: max-age=604800 Age: 100 ###重要 调用使用标头进行身份验证的 API 时，请勿将任何机密提交到源代码存储库。 正文在空白行后面添加请求正文，如以下示例所示： 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" } ### 不支持的语法Visual Studio 2022 .http 文件编辑器不具备 Visual Studio Code REST 客户端扩展拥有的所有功能。 以下列表包含一些仅在 Visual Studio Code 扩展中可用的更重要的功能： 可选的 HTTP 方法 跨多行的请求行 命名请求 设置动态变量 环境文件 将文件路径指定为请求正文 使用 multipart/form-data 时正文的混合格式 GraphQL 请求 cURL 请求 复制/粘贴为 cURL 请求历史记录 将响应正文保存到文件 基于证书的身份验证 提示变量 系统变量 自定义响应预览 每请求设置Visual Studio 2022 .http 文件编辑器仍处于预览状态，其中一些功能可能会在将来添加。 使用 .http 文件编辑器通过使用“添加新项”对话框或将任何文本文件的扩展名重命名为 .http 来创建 .http 文件。 通过选择请求左侧的绿色“运行”按钮发送请求。 响应显示在单独的窗格中。 创建 .http 文件在“解决方案资源管理器”中，右键单击 ASP.NET Core 项目。 在上下文菜单中，选择“添加”>“新建项...”。 在“添加新项”对话框中，选择“ASP.NET Core”>“常规”。 选择“HTTP 文件”，然后选择“添加”。
向 .http 文件添加至少一个请求并保存该文件。 如果请求 URL 指向 localhost 和项目的端口，请在尝试向其发送请求之前运行项目。 选择要发送的请求左侧的绿色“运行”按钮。 请求将发送到指定 URL，响应将显示在编辑器窗口右侧的单独窗格中。
终结点资源管理器是 Visual Studio 2022 中的一个工具窗口，它提供与 .http 文件编辑器集成的 UI，用于测试 HTTP 请求。 启用终结点资源管理器终结点资源管理器仍是预览功能。 它在 Visual Studio 2022 版本 17.6 预览版 6 及更高版本中可用，必须启用它。 为此，请选择“工具”>“选项”>“环境”>“预览功能”>“Web API 终结点资源管理器”。 打开终结点资源管理器选择“查看”>“其他 Windows”>“终结点资源管理器”。 向 .http 文件添加请求在“终结点资源管理器”中右键单击请求，然后选择“生成请求”。
前面的屏幕截图显示了由最小 API 项目模板定义的终结点。 以下示例显示为所选终结点生成的请求： @ApiApplication1_HostAddress = http://localhost:5155 Get {{ApiApplication1_HostAddress}}/todos/ ###如本文前面所述发送请求。 另请参阅 Visual Studio 2022 中的 Web API 开发 Visual Studio Code REST 客户端扩展 |
【本文地址】
今日新闻 |
推荐新闻 |