HTTP Client: 在 Pycharm 中直接发送 HTTP 请求

这算是第一次写博客吧，总觉得自己技术挺渣，写不出高质量的内容，所以就想先介绍一些自己平时工作中经常使用的工具，希望能坚持吧~

简介

HTTP Client 是 Jetbrains 系列软件中自带的 HTTP 请求工具，不过只在 Professional 版本才有这个功能，我平时开发使用的是 Pycharm 2018.3。在 VS Code 中有相同功能的插件 REST Client. 以下的内容全部来自 官方教程，不过是英文的，有能力可以直接看文档，这里根据自己的理解从简单到复杂梳理官方教程的常用功能.

创建请求脚本

创建请求脚本，跟创建一个 Python 文件一样，在需要创建的文件夹 右击 | New | HTTP Request 即可，一般在最下方，请求脚本是一个以 http 为扩展名的文件.

创建请求脚本

请求语法

创建好脚本以后，会有一些注释告诉你可以使用模板快速生成请求，这里可以先忽略，下面来说请求语法.

Method Request-URI HTTP-Version
Header-field: Header-value

Request-Body

语法很简单，就是 HTTP 请求的基本概念，按顺序分别是 请求方法、请求地址、HTTP版本、请求头、请求体. 其中 HTTP-Version 一般省略不写，如果一定要写，按照 HTTP/*.* 格式就好. 请求头、请求体 没有也可以不写，所以一个最简单的请求应该是这样的:

最简单的请求

点击左侧的 箭头 就可以发出请求，请求的结果会输出在下方. 在脚本中, 注释可以用 # 或者 // 表示，如果想在一个脚本文件中编写多个请求，可以使用 ### 进行分割.

使用生成模板

了解语法之后就可以使用新建文件时注释中的快速生成模板了，Tab 键自动生成.

• gtr[p]: 获取 json 格式数据，p 会自动生成参数
• ptr[p]: 上传 json 数据，p 会自动生成参数
  • 上传 json 需要在请求体编写数据，注意使用 双引号
• mptr | fptr: 提交一个文本或文件表单
  • 如果提交文件表单，可以使用 < filepath 指定 文件路径, 这里使用相对路径即可.

使用环境变量

当你在编写请求的时候，可以使用 环境变量 将一些字段参数化，例如 使用 {{ host }} 占位符表示 主机地址，当发起请求的时候，会让你选择是使用 生产环境 还是 开发环境, 之后从选择的环境中读取指定字段的值.

环境变量通过名为 http-client.env.json 的配置文件完成，配置文件创建在请求脚本的同级目录，键 表示 环境，值 表示环境变量，这里使用 development、 production 分别表示 开发环境 和 生产环境，如果有多个环境，直接增加 键 即可，示例如下:

{
    "development": {
        "host": "localhost",
        "id-value": 12345,
        "username": "dev_username",
        "password": "dev_password",
        "my-var": "my-dev-value"
    },

    "production": {
        "host": "example.com",
        "id-value": 6789,
        "username": "pro_username",
        "password": "pro_password",
        "my-var": "my-prod-value"
    }
}

构建请求的时候就可以这样:

GET http://{{host}}/api/json/get?id={{id-value}}&key={{unresolved_var}}
Authorization: Basic {{username}} {{password}}
Content-Type: application/json
{
    "key": {{my-var}}
}

点击左边箭头执行，就会让你选择是使用什么环境发送请求. 如果一个环境变量没有找到，比如上面的 {{unresolved_var}}，将会被作为 原始字符发送.

在一个请求中可以使用环境变量占位符的部分为:

• 请求 地址、端口、路径
• 查询字符串 参数 或 值
• 请求头
• 请求体 或者 外部文件

官方示例

通过上面这些，已经可以完成常用的请求发送了，官方也提供了一些示例进行参考，在 请求文件 右上角，将鼠标移过去就会显示出来，左边是 请求历史，右边 是 请求示例:

示例

总结

这里只是列了常用用法，具体细节还是要看 文档. HTTP Client 同样可以使用 JavaScript ECMAScript 5.1 语法处理响应，例如对请求结果进行 断言 等，这样就可以形成一个完整的接口测试，通过查看 响应API 了解更多.