测试接口----VSCode插件REST Client

1.常规
步骤一：安装 REST Client 插件
步骤二： 创建一个 .http 或 .rest 文件
步骤三：写入测试接口
1） 符合 RFC 2616 标准的 POST 请求

POST http://dummy.restapiexample.com/api/v1/create HTTP/1.1
content-type: application/json

{
    "name":"Hendry",
    "salary":"61888",
    "age":"26"
}

2）符合 cURL 标准的 POST 请求

curl -X POST "http://dummy.restapiexample.com/api/v1/create" -d "Hello World"

如果省略 request 方法，请求将被视为 GET 。
注意：接口间通过 ### 分隔，同一个 .http 文件里可以涵盖多个 HTTP 请求。不像 Postman，不同的 HTTP 请求需要放在不同的 tab 里。
步骤四：发送请求，测试接口
点击 Send Request ，或者右键选择 Send Request ，或者直接用快捷键 Ctrl+Alt+R（或Cmd+Alt+R） ，你的 REST API 就执行了，然后 API Response 就会显示在右边区域。

2. 不常规
一个 http 文件可能定义许多请求和文件级自定义变量，很难找到你想要的请求/变量。我们可以使用快捷键 Ctrl+Shift+O（或Cmd+Shift+O）来切换请求/变量。
自定义环境变量
不同的环境（开发、测试、生产），API 接口参数可能有所不同，我们不可能每次切换环境的时候，都手动修改代码，所以我们可以自定义项目的环境变量，每次切换即可。
点击 Code => Preferences => Settings 打开设置，切换到 Workspace Settings ，配置 settings.json 文件：

{
  "rest-client.environmentVariables": {
    "$shared": {
        "version": "v1",
        "prodToken": "foo",
        "nonProdToken": "bar"
    },
    "local": {
        "version": "v2",
        "host": "localhost",
        "dummyhost": "local",
        "token": "{{$shared nonProdToken}}",
        "secretKey": "devSecret"
    },
    "production": {
        "host": "api.apiopen.top",
        "dummyhost": "dummy.restapiexample.com",
        "token": "{{$shared prodToken}}",
        "secretKey" : "prodSecret"
    }
  }
}

可以切换不同的环境（Ctrl+Alt+E 或 Cmd+Alt+E），调用相应的配置项（host 、 token 等）。

### 测试接口 RFC 2616
// host 为环境变量
GET https://{{host}}/musicRankings HTTP/1.1

当然，rest-client 还有更多的配置项，例如：

• rest-client.defaultHeaders ：默认的 header 请求体，默认为 { “User-Agent”: “vscode-restclient”, “Accept-Encoding”: “gzip” } ；
• rest-client.timeoutinmilliseconds ：超时时长，默认为 0 ms；
• rest-client.previewOption ：控制哪些部分应该通过rest-client预览，可选 full 、 headers 、 body 、 exchange ，默认为 full ；
• rest-client.followredirect ：是否支持 HTTP 3xx 的重定向，默认支持；

自定义文件变量
我们可以在 HTTP 文件任意位置定义文件变量，它们都可以在整个文件的任何请求中引用。例如：

// 文件变量
@port = 8080
@contentType = application/json

### 测试接口 RFC 2616
// 文件变量
@name = musicRankings
GET https://{{host}}/{{name}} HTTP/1.1

• 对于文件变量，定义遵循 @variableName = variableValue 占用完整行的语法；
• 变量名称（variableName）不得包含任何空格。至于变量值（variableValue），它可以由任何字符组成，甚至允许空格（前导和尾随空格将被剥离）；
• 如果你想保留一些像换行符这样的特殊字符，你可以使用反斜杠 \n ；

自定义请求变量
当单个请求结果的值需要被其它请求使用时，可以使用请求变量，格式为：@name newname ，请求变量引用语法为 {{requestName.(response|request).(body|headers).(JSONPath|XPath|Header Name)}}。

@contentType = application/json

###

# @name createComment
POST https://{{host}}/comments HTTP/1.1
Content-Type: {{contentType}}

###

# @name getCreatedComment

GET https://{{host}}/comments/{{createComment.response.body.$.id}} HTTP/1.1

Authorization: {{login.response.headers.X-AuthToken}}

系统变量
系统自带的一些变量，使用系统变量需要有 $符号

• {{$guid}} 唯一识别号
• {{$randomInt min max}} 返回一个min 和 max 之间的随机数
• {{$timestamp [offset option]}}：添加UTC时间戳。
• {{KaTeX parse error: Expected 'EOF', got '}' at position 24: …p number option}̲}，例如3小时前{{timestamp -3 h}};代表后天{{$timestamp 2 d}}。

官方文档
vscode-restclient