使用 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 了解更多.