Pycharm
 
2023.3
快捷方式：Windows
获取 PyCharm
  1. 语言和框架
  2. HTTP客户端
  3. HTTP 响应处理 API 参考
  4. HTTP请求和响应参考

专业的
HTTP请求和响应参考

最后修改时间：2023 年 8 月 24 日

仅适用于 PyCharm Professional：下载以尝试或 比较版本

响应特性

该response对象保存有关收到的 HTTP 响应的信息（响应内容、标头、状态等），并提供对标头和contentType嵌套对象的访问。

财产

描述

body（字符串 | TextStreamResponse | 对象）

响应内容，可以是字符串、TextStreamResponse对象或JSON对象。

headers（响应头）

响应标头存储对象。

status（整数）

响应状态，例如200或404。

contentType（内容类型）

contentType对象，保存Content-Type响应标头值的数据。

标头对象

该ResponseHeaders对象用于检索有关响应标头值的数据。

方法

方法

参数

描述

headerName（细绳）

检索响应标头的第一个值headerName，或者null如果headerName响应标头不存在。

值

headerName（细绳）

检索包含响应标头的所有值的数组headerName。headerName如果响应头不存在，则返回空数组。

内容类型对象

数据ContentType对象包含来自Content-Type响应标头的信息。

特性

财产

描述

mimeType（细绳）

响应的 MIME 类型，例如text/plain、text/xml、application/json。

charset（细绳）

响应字符集的字符串表示形式，例如utf-8。

TextStreamResponse 对象

该TextStreamResponse接口用于将响应作为文本流进行处理。它允许您实现两种方法：

  • onEachLine(subscriber, onFinish)，它循环流中的每一行。

  • onEachMessage(subscriber, onFinish)，它订阅服务器发送的每条消息。这可用于基于 WebSocket 的 WebSocket、GRPC 和 GraphQL。

论据

争论

onEachLine 中的用法

onEachMessage 中的用法

subscriber

处理流线的函数。它需要两个参数：

  • line：作为流的一部分接收的字符串或 JSON 对象。

  • unsubscribe：终止当前块执行的函数onEachLine。它可用于在满足特定条件时停止流处理。

处理流消息的函数。它需要三个参数：

  • message：作为流的一部分接收的字符串或 JSON 对象。

  • unsubscribe：终止当前块执行的函数onEachMessage。它可用于在满足特定条件时停止流处理。

  • output（可选）：一个函数，它接受一个字符串（消息）并将其参数发送回服务器。

onFinish

流结束后执行的函数。

有关如何使用它的示例，请参阅响应处理示例或单击.http文件中的示例并选择WebSocket 请求或GraphQL 请求。

请求属性

该request对象保存有关 HTTP 请求的信息，并且可以在预请求脚本和响应处理程序脚本中使用。

财产

在预请求脚本中使用时

在响应处理程序脚本中使用时

body

使用以下两种方法之一获取请求正文：

  • getRaw()：以原始格式返回请求主体：如果请求主体包含变量，则显示它们的名称而不是它们的值。

  • tryGetSubstituted()：返回请求正文，其中所有已知变量都替换为它们的值。

请求正文为字符串，例如client.log(request.body())。

environment

具有方法，该方法检索由其标识的环境变量get(name)的值，如果不存在则返回。namenull

headers

有两种方法：

  • all：返回包含当前请求的所有标头值的数组。

  • findByName(name)：检索参数标识的标头的值name。

数组的每个元素都是一个请求头，具有以下方法：

  • name: 标头名称，例如Content-Type.

  • getRawValue：以原始格式返回标头值：如果标头包含变量，则显示它们的名称而不是它们的值。

  • tryGetSubstitutedValue()：返回标头，其中所有已知变量都替换为它们的值。

数组的每个元素都是一个请求头，具有以下方法：

  • name: 标头名称，例如Content-Type.

  • value(): 标头值，例如application/json.

url

使用以下两种方法之一获取请求 URL：

  • getRaw()：以原始格式返回请求 URL：如果 URL 包含变量，则显示它们的名称而不是它们的值。

  • tryGetSubstituted()：返回请求 URL，其中所有已知变量都替换为它们的值。

请求 URL 作为字符串。

variables

具有方法，该方法检索由其标识的每个请求变量get(name)的值，如果不存在则返回。namenull