vscode 插件: REST Client 介绍

在 Visual Studio Code 有一款简单实用的 HTTP 请求插件名为 REST Client，可以帮助我们在日常的接口开发过程中简化接口的请求调试方式，并加速开发进程。这里做一个简单介绍。

这款插件可以帮助我们完成我们想要的 REST 风格的请求，类似于 PostMan，但是确是另外一种"所见即所得"风格的请求方式。对于 PostMan 而言有一个缺点，对于开发者是很不友好的那就是界面结构复杂，当我们想要做一些简单的请求的时候往往需要进行大量的设置。比如当我们想要发起一个请求的时候往往需要经历 “新建标签页”->“输入URL”->"输入参数"等操作，好处是我们做的每次请求都会被保存下来，而且对于不同的请求可以实现集中式管理；缺点也很明显，操作太复杂了。这时候 REST Client 就派上用场了，我们的所有内容的编写都可以写在一个文件中并完成请求，参数内容等一目了然。

使用方法

首先我们在 Visual Studio Code 中搜索并安装 REST Client 插件。

在安装完成后我们便可以在随便一个目录下编写请求逻辑并执行请求了，这里我们新建一个文件夹 rest 并且在该目录下打开一个新的 Visual Studio Code 窗口。

新建一个文件，并且命名为 dem01.http。

注意这里的文件名称是我定义的，在实际使用中可以按照需要更改，但要求以 .rest 或者 .http 结尾，REST Client插件会识别后缀为这两种类型的文件并对文件中内容处理。

接下来我们便可以这个文件中编写请求内容了，格式要求所有请求前一行需要以三个#号开头用来标记下面的内容是一个请求。后面的请求内容可以以HTTP风格进行编写：

###
GET http://localhost:9001/user/1
# 单个#号用来标记注释

上面的请求在执行时会对 http://localhost:9001/user/1发送一个 GET 请求。如果我们想要发送 POST 或者其他方式的请求只需要修改 GET 头即可。

###
POST http://localhost:9001/user/add
Content-Type: application/json

{
    "id":1,
    "name":"yuxin",
    "age":26,
    "addr":"china"
}

上面的示例会对http://localhost:9001/user/add发送一个 POST 请求，并且携带下面的数据。我们这里指定了 header 的 Content-Type为 json格式，表名下面的数据为 json 类型。

在使用GET请求时，使用 REST Client 也无须将请求行中的参数全部放在一行，换行可以帮助我们更好的格式体验：

###
GET http://localhost:9001/user/add
	?id=1
	&name=yuxin
	&age=26
	&addr=china

变量的使用

除此之外，REST Client 还支持使用变量，我们可以通过指定变量避免重复性的编辑操作。变量的定义格式是@变量名=值，变量使用时，只需要使用 {{变量名}}的格式引用变量即可。
示例：

# 设置端口为 9001
@port = 9001

###
GET http://localhost:{{port}}/user/1

输入文件

我们可以配合多个文件处理请求，请求内容保存在其他文件中。默认以 UTF8 编码格式读取

###
POST http://localhost:9001/user/add
Content-Type: application/json

@ <./user1.json

当前目录下 user1.json 文件的内容：

{
    "id":1,
    "name":"yuxin",
    "age":26,
    "addr":"china"
}

总结

上述内容只是对 REST Client 进行一个简单的介绍，如果感兴趣，可以到REST Client 主页获取更多的功能使用方法。

参考资料

REST Client