VsCode 扩展巡礼-REST Client

needrunning

发布于 2019-08-06 11:27:19

2.6K0

发布于 2019-08-06 11:27:19

文章被收录于专栏：图南科技图南科技图南科技

基本介绍

RestClient是VsCode商店的有个http访问扩展，官方地址 RestClient，用于模拟Http请求。

官方介绍中关注两点

1 基本的Http请求模拟，Http输入和Http响应 2 VsCode自带的辅助功能，如自动补全Http Content-Type等

VsCode 扩展巡礼-REST Client-图南科技.png

RestClient的优势

RestClient是一个http请求模拟插件，有人会说我用PostMan也可以实现同样的功能，没错。但是在我看来，RestClient的优势以下几点

1 与VsCode结合，方便开发人员进行接口单元测试。 2 基于手写http报文进行请求，并且报文有严格的格式，编写者可以对Http协议和报文进行深入理解，如何设置请求头，如何组织不同Content-Type的请求参数，都会涉及到。

3 在前后端分离已经成为开发团队主流标配的情况下，开发人员可以对后端接口进行单元测试，QA人员可以进行单独验收，RestClient都是高效可靠的工具。

http 报文内容格式

以下是VsCode REST Client中常用的两种请求方式的http 报文内容

application/json 请求

GET

GET https://example.com/topics/1 HTTP/1.1

POST

POST https://example.com/comments HTTP/1.1
content-type: application/json
{
"name": "sample",
"time": "Wed, 21 Oct 2015 18:27:50 GMT"
}

application/x-www-form-urlencoded 请求

GET

GET https://example.com/comments
?page=2
&pageSize=10

POST

POST https://api.example.com/login HTTP/1.1
Content-Type: application/x-www-form-urlencoded
name=foo
&password=bar

以下图片中可以看到请求端请求和服务端返回，蓝色框中是跨域相关的设置

RestClient.png

发送嵌套json请求

Content-Type: application/json

{
    "type":1,
    "data":{
        "vcc_code" : "",
        "server_num" : "0102000558",
        "cus_phone" : "100",
        "cus_phone_areacode" : "",
        "cus_phone_areaname" : "",
        "cus_phone_type" : "TEL",
        "ag_name" : "20",
        "ag_num" : "30",
        "ag_phone" : "8001",
        "endResult_code" : "12",
        "user_data" : []
    }
}

HTTP Language

Add language support for HTTP request, with features like syntax highlight, auto completion, code lens and comment support, when writing HTTP request in Visual Studio Code. By default, the language association will be automatically activated in two cases:

File with extension .http or .rest
First line of file follows standard request line in RFC 2616, with Method SP Request-URI SP HTTP-Version format

以上是github文档中的说明，大致两个意思

1 Http报文的文件后缀可以是.http或者.rest. 这样VsCode可以识别出来这是报文文件，自动提示，色彩显示呀，很漂亮。

项目中可以将报文文件以文件夹中，http文件的形式归档整理，作为项目的一部分。

2 报文的格式，严格按照 RFC 2616，主要是一行一个元素。

再说ContentType

这里做一个简单的介绍

multipart/form-data：需要在表单中进行文件上传时，就需要使用该格式 application/json：application/json 这个 Content-Type 作为响应头大家肯定不陌生。

实际上，现在越来越多的开发者把它作为请求头，用来告诉服务端消息主体是序列化后的 JSON 字符串

application/x-www-form-urlencoded：默认的 contencType，当 form 表单请求为 get 时，数据被编码为 key/value 格式（name1=value1&name2=value2…），然后把这个字串 append 到 url 后面，用 ? 分割，加载这个新的 url 发送到服务器（表单默认的提交数据的格式）。

当请求为 post 时，浏览器把 form 数据封装到 http body 中，然后发送到 server。

form 的 enctype 属性为编码方式，常用有两种：application/x-www-form-urlencoded 和 multipart/form-data，默认为 application/x-www-form-urlencoded。

常见问题梳理

1 ContentType不对应

简单来说 ContentType 的作用是来约定请求方与接收方对于Http报文的处理位置，请求方关心传递参数，服务方关心接收参数。如果ContentType不一致，就是造成传递与接收参数的位置不对应，客户端传值正确，服务器端接收不到值的情况。

现在大家都提倡使用 application/json，少数项目或者开发者还是坚持使用Content-Type: application/x-www-form-urlencoded

2 报文格式不准确

切记一行一组元素

看看头部的格式

Post http://dev.com/api/v1/c/history/list HTTP/1.1
Content-Type: application/json
app-key: 562986529
time-stamp: 1553581026034
token: 9f3f7cd61ca7a4d24954c1bfc3e6ead7

token 虽然是字符串，但是没有引号，key 冒号空格。报文的书写有助于深入理解Http报文原理。

开发案例case

PHP编程中请求接口主要使用的组件有Curl，Zend，Guzzle这三种

Curl请求

使用Curl请求，需要注意的依然是 x-www-form-urlencoded下的参数传递问题

https://blog.csdn.net/qq_35641923/article/details/81386708

php curl 转为 x-www-form-urlencoded 方式的坑。

网上转变的方法基本都是写添加下面这句：

curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/x-www-form-urlencoded'));

但加上去后却根本没效果。

要想以 x-www-form-urlencoded 方式发送，最关键其实是发送的数据格式。

Content-type from-data时发送的数据用的是array格式，而Content-type为 x-www-form-urlencoded 时需要用key=value&key=value的格式发送，发送的是string型的数据。

from-data数据的为：

$data = [
'name' => 'xiaoming',
'sex' => 1
];

x-www-form-urlencoded时的数据则要变为

$params_string = http_build_query($params);

否则
$params_json = json_encode($params);

guzzle组件中的content-type

组件官方文档，请移步这里 Guzzle, PHP HTTP 客户端

x-www-form-urlencoded 请求

如何发送一个 application/x-www-form-urlencoded POST请求.

guzzle-form.png

json 请求

guzzle-json.png

Guzzle访问实例初始化失败

如果我们的地址少些一个字母或者多写字母导致远程接口不能解析，会出现什么情况？

 /**
     * Post请求
     *
     * @return void
     */
    protected function post()
{
        try {
            $this->request = $this->client->post($this->uri, ['form_params' => $this->params], $this->option);
        } catch (\GuzzleHttp\Exception\RequestException $e) {
           
            var_dump($error);
            die();
            Yii::warning($e);
        }
    }

2019-07-13 09:39:06 [127.0.0.1][-][-][warning][application] GuzzleHttp\Exception\ConnectException: cURL error 6: Could not resolve: xx.cn (Timeout while contacting DNS servers) (see http://curl.haxx.se/libcurl/c/libcurl-errors.html) in /Users/name/sources/vendor/guzzlehttp/guzzle/src/Handler/CurlFactory.php:185
Stack trace: