VSCode 插件 - Rest Client 使用简要说明

记录一下,方便以后查阅使用

插件名称 : REST Client

  1. 接口调用文件扩展名为 .http.rest
  2. 遵从 [RFC 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec5.html) 规范

单个请求

GET 请求

GET http://localhost:9501/?user=112 HTTP/1.1

POST 请求

POST http://localhost:9501/auth/test3 HTTP/1.1
Content-Type: application/x-www-form-urlencoded

user=12322

多个请求

使用 ### 分隔, 比如

GET http://localhost:9501/auth/test1?user=111 HTTP/1.1

###

GET http://localhost:9501/auth/test2?user=121 HTTP/1.1

###

GET http://localhost:9501/auth/test?user=131 HTTP/1.1

变量使用

获取前一个请求参数和变量使用

@baseUrl = http://localhost:9501

# @name getuser
POST {{baseUrl}}/user/get HTTP/1.1
Content-Type: application/x-www-form-encoded

id=1&t=123

###

@authToken = {{getuser.response.headers.X-AuthToken}}
@username = {{getuser.response.body.$.username}}

# @name display
GET {{baseUrl}}/user/show?name={{username}} HTTP/1.1
Authorization: {{authToken}}

POST 提交文件时

使用 < 将本地文件附加到请求体中

演示如下

POST http://localhost/parseJson HTTP/1.1
Content-Type: application/json

< ./data.json

快捷键

Ctrl+Alt+R (OSX: Cmd+Alt+R) 发起光标所在定义位置的请求
Ctrl+Alt+K (OSX: Cmd+Alt+K) 取消当前的请求
Ctrl+Alt+L (OSX: Cmd+Alt+L) 重新执行前一次请求
Ctrl+Alt+H (OSX: Cmd+Alt+H) 查看请求历史
Ctrl+Alt+C (OSX: Cmd+Alt+C) 生成请求代码片断 如果快捷键冲突,可以在请求体点击右键,选择Generate Code Snippet 并按提示进行请求代码片断生成
Ctrl+Shift+O (OSX: Cmd+Shift+O) 快速浏览请求定义

常见的表单类型

POST 表单时的内容类型

Content-Type: application/json
Content-Type: application/xml
Content-Type: application/x-www-form-encoded

Basic Auth

Authorization: Basic user:passwd
Authorization: Basic base64(user:passwd)
Authorization: Basic user passwd

Digest Auth

Authorization: Digest user passwd

更多内容请参考

赞赏