.NET 8中的Api.http文件是什么?如何用它测试API端点?
关于.NET 8中Api.http文件的说明与使用方法
什么是Api.http?
Api.http是.NET生态中支持HTTP请求测试的专用文件,基于标准HTTP文件规范,集成在Visual Studio、VS Code等编辑器中,无需第三方测试工具,就能直接在开发环境里快速测试ASP.NET Core API端点。
具体操作步骤
1. 创建/获取Api.http文件
- 新建ASP.NET Core 8项目时,Web API等模板会自动生成该文件;
- 如果项目中没有,手动在任意目录下新建文本文件,将文件名改为
Api.http(后缀必须为.http)。
2. 编写HTTP请求
每个请求由请求方法+URL、请求头(可选)、请求体(仅POST/PUT等方法需要)组成,多个请求用###分隔。示例:
### GET请求获取商品列表 GET https://localhost:5001/api/products Accept: application/json ### POST请求创建商品 POST https://localhost:5001/api/products Content-Type: application/json { "name": "测试商品", "price": 99.9 }
3. 发送请求并查看结果
- Visual Studio环境:每个请求上方会显示「Send Request」按钮,点击后右侧弹出「HTTP Response」窗口,展示响应状态码、响应头和响应体;
- VS Code环境:先安装「REST Client」插件,之后每个请求上方会出现「Send Request」选项,点击后响应结果在新标签页显示。
4. 进阶:用变量简化配置
可以定义全局变量复用URL、令牌等信息,提升测试效率:
// 定义全局变量 @baseUrl = https://localhost:5001 @authToken = eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... ### 带认证的GET请求 GET {{baseUrl}}/api/products Accept: application/json Authorization: Bearer {{authToken}}
也可创建.env文件管理不同环境(开发/测试)的变量,Api.http会自动读取对应配置。
注意事项
- 测试前确保ASP.NET Core项目已启动,且Api.http中的URL端口与项目启动端口一致;
- 发送带请求体的请求时,必须设置正确的
Content-Type请求头(比如application/json对应JSON格式请求体); - 涉及认证的API,需在请求头中携带有效的认证信息(如JWT令牌)。
内容的提问来源于stack exchange,提问作者Lisa
相关产品推荐
相关产品推荐

