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

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

简介

HTTP ClientJetbrains 系列软件中自带的 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 的配置文件完成,配置文件创建在请求脚本的同级目录, 表示 环境 表示环境变量,这里使用 developmentproduction 分别表示 开发环境生产环境,如果有多个环境,直接增加 即可,示例如下:

{
    "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 了解更多.

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335