构建请求

您可以在 Postman 中发送请求以连接到您正在使用的 API。您的请求可以检索、添加、删除和更新数据。无论您是构建或测试自己的 API,还是与第三方 API 集成,您都可以在 Postman 中尝试您的请求。您的请求可以发送参数、授权详细信息以及您需要的任何正文数据。

例如,如果您正在为商店构建客户端应用程序(例如移动或 Web 应用程序),您可能会发送一个请求来检索可用产品列表,另一个请求来创建新订单(包括选定的产品详细信息) ),以及将客户登录到其帐户的不同请求。

当您发送请求时,Postman 会显示从 API 服务器收到的响应,以便您检查、可视化并在必要时对其进行故障排除。

请求已发送

如果您以前从未发送过请求,请在继续之前检查发送您的第一个请求

内容

创建请求

您的请求可以包含多个详细信息,以确定 Postman 将发送到您正在使用的 API 的数据。输入 URL 并选择一种方法,然后可以选择指定各种其他详细信息。

您可以从 Postman 主屏幕创建新请求,方法是使用New > HTTP Request或选择+按钮打开一个新选项卡。

新画面

选择保存以创建您的请求。您可以为您的请求提供名称和描述,然后选择或创建一个集合来保存它。

打开新选项卡后,您可以指定请求所需的详细信息。

新请求

添加请求详细信息

如果您有要运行的请求,则需要知道 URL、方法和其他可选值,例如 auth 和参数。

如果您尝试在 Postman 中发送请求,您可以将 URL 设置为 Postman Echo 示例 API 端点https://postman-echo.com/get并将方法设置为GET,然后选择发送以查看会发生什么。

在 Postman 中打开Bootcamp并按照Designing and mocking APIs导入一些可用于探索 Postman 的请求。

设置请求 URL

您在 Postman 中发送的每个请求都需要一个代表您正在使用的 API 端点的 URL。您可以使用 API 执行的每个操作通常都与端点相关联。API 中的每个端点都可以在特定的 URL 上使用。这是您进入 Postman 以访问 API 的内容。

  • 如果您正在构建 API,则 URL 通常是基本位置加上路径。例如,在 requesthttps://postman-echo.com/get中,https://postman-echo.com是基本 URL,/get是端点路径。
  • 如果您使用第三方 API,您的 API 提供商将提供您需要的 URL,例如在他们的开发者文档中。

当您开始在 URL 输入字段中输入时,Postman 将显示一个下拉列表,其中包含您可以用来自动完成的以前使用的位置。

http://如果您未指定协议,邮递员将自动添加到您的 URL 的开头。

您可以选择在 URL 字段中键入查询参数,也可以在“参数”选项卡中输入它们。如果您的请求使用路径参数,您可以将它们直接输入到 URL 字段中

您可以在请求中使用下一代 URL 编码

选择请求方法

默认情况下,Postman 将选择GET新请求的方法。GET方法通常用于从 API 检索数据。您可以使用多种其他方法将数据发送到您的 API,包括以下最常见的选项:

  • POST— 添加新数据
  • PUT— 替换现有数据
  • PATCH— 更新一些现有的数据字段
  • DELETE— 删除现有数据
请求方法

例如,如果您正在使用待办事项列表应用程序的 API,您可能会使用一种GET方法来检索当前任务列表、一种POST方法来创建新任务,以及一种PUTPATCH方法来编辑现有任务。

Postman 默认支持许多额外的请求方法,您可以使用自定义方法。选择方法下拉列表,编辑方法名称文本,然后保存新方法。要删除方法,请将鼠标悬停在列表中的该方法上,然后选择垃圾桶图标。

要试用https://postman-echo.com/get端点,请GET选择方法并选择发送

同一个位置(有时称为“路由”)可以通过接受不同的方法来提供多个端点。例如,API 可能有一个POST /customer用于添加新客户的GET /customer端点和一个用于检索现有客户的端点。

  • 如果您的请求不需要参数或身份验证,您可以选择发送以获取响应。
  • 否则,请指定您需要发送到 API的参数和任何正文数据。
  • 如果您不需要随请求发送数据,请设置任何必需的身份验证标头

发送参数

您可以使用 URL 字段和“参数”选项卡随请求发送路径和查询参数。

  • 查询参数附加到请求 URL 的末尾,?并以键值对的形式列出,并&使用以下语法分隔:?id=1&type=new
  • 路径参数构成请求 URL 的一部分,并使用前面的占位符引用:,如下例所示:/customer/:id

要发送查询参数,请将其直接添加到 URL 或打开Params并输入名称和值。您可以在 URL 或 UI 字段中输入查询参数,它将在其他地方更新。

参数不会自动进行 URL 编码。右键单击所选文本,然后选择EncodeURIComponent以手动对参数值进行编码。

要发送路径参数,请在 URL 字段中输入参数名称,在冒号后,例如:id. 当您输入路径参数时,Postman 会将其填充到“参数”选项卡中,您也可以在其中对其进行编辑。

路径参数

您可以为您的参数添加描述,并且它们将显示给任何共享请求(例如在您的工作区中)或查看您的 API 文档的人。

如果您更喜欢以文本形式输入参数而不是使用 UI,则可以使用批量编辑选项。

如果您的请求不需要正文数据、身份验证或标头,请继续并选择发送来试用。否则,设置你的bodyauthheaders

发送正文数据

每当您需要添加或更新结构化数据时,您都需要发送带有请求的正文数据。例如,如果您要发送将新客户添加到数据库的请求,您可能会在 JSON 中包含客户详细信息。通常,您会将正文数据与PUTPOSTPATCH请求一起使用。

Postman 中的Body选项卡允许您指定需要随请求一起发送的数据。您可以发送各种不同类型的正文数据以适合您的 API。

如果您要发送正文数据,请确保选择了正确的标头以指示您的 API 可能需要正确处理接收到的数据的内容类型。

  • 对于表单数据和 urlencoded 正文类型,Postman 将自动附加正确的Content-Type标题。
  • 如果您对正文数据使用原始模式,Postman 将根据您选择的类型(例如文本或 json)设置标题。
  • 如果您手动选择Content-Type标题,则该值将优先于 Postman 设置的值。
  • Postman 没有为二进制正文类型设置任何标头类型。

默认情况下,Postman 将选择“”——如果您不需要随请求发送正文,请保持选中状态。

选择请求正文所需的数据类型——表单数据URL 编码原始二进制GraphQL

表单数据

网站表单通常以multipart/form-data. form-data 您可以使用“正文”选项卡在 Postman 中复制此内容。表单数据允许您发送键值对,并指定内容类型。

表格数据

您可以使用表单数据附加文件。当您反复进行发送相同文件的 API 调用时,Postman 将保留您的文件路径以供后续使用。这也有助于您运行包含需要上传文件的请求的集合。不支持上传多个文件,每个文件都有自己的内容类型。

URL 编码

URL 编码的数据使用与 URL 参数相同的编码。如果您的 API 需要 url 编码的数据,请在请求x-www-form-urlencoded的“正文”选项卡中选择。输入要与请求一起发送的键值对,Postman 将在发送前对其进行编码。

表单数据和 url 编码之间有时会混淆。如果您不确定需要哪一个,请咨询您的 API 提供商。

原始数据

您可以使用原始身体数据来发送您可以作为文本输入的任何内容。使用raw选项卡和类型下拉列表来指示数据的格式(TextJavaScriptJSONHTMLXML),Postman 将启用语法突出显示以及将相关标头附加到您的请求中。

正文 JSON

如果您需要覆盖 Postman 自动发送的内容,您可以手动设置内容类型标题。

您可以在您的正文数据中使用变量,Postman 将在发送您的请求时填充它们的当前值。

要美化您的 XML 或 JSON,请在编辑器中选择文本,然后选择⌘+Option+BCtrl+Alt+B

二进制数据

您可以使用二进制数据发送在 Postman 编辑器中无法通过请求正文手动输入的信息,例如图像、音频和视频文件(您也可以发送文本文件)。

GraphQL

您可以通过选择请求正文中的GraphQL选项卡来发送带有 Postman 请求的 GraphQL 查询。在查询区域中输入您的代码,并在GraphQL 变量部分中输入任何变量。

查看使用 GraphQL部分以获取有关 GraphQL 的更多信息,包括如何启用由 Postman API 模式提供支持的自动完成功能。

验证请求

某些 API 需要您可以在 Postman 中发送的身份验证详细信息。身份验证涉及验证发送请求的客户端的身份,而授权涉及验证客户端是否有权执行端点操作。打开授权选项卡以配置您的访问详细信息。

请求授权

Postman 会自动在请求的相关部分中包含您的身份验证详细信息,例如在Headers中。

有关在 Postman 请求中实现不同类型的身份验证的更多详细信息,请查看Authorizing requests

设置身份验证和其他请求详细信息后,选择发送以运行您的请求。

配置请求标头

某些 API 要求您随请求一起发送特定的标头,通常是为了提供有关您正在执行的操作的其他元数据。您可以在“标题”选项卡中设置这些。输入您需要的任何键值对,Postman 会将它们与您的请求一起发送。在您键入时,Postman 将提示您提供可用于自动完成设置的常用选项,例如Content-Type.

标题类型

您可以将常用的标题一起保存在标题预设中。在标题选项卡中,选择预设,然后选择管理预设。通过提供名称并输入键加值来添加每个预设。选择添加,您的预设将在预设下拉列表中可用。选择预设将自动填充请求标头中的字段。

自动生成的标题

Postman 会根据您的请求选择和设置自动将某些标头添加到您的请求中。选择标题选项卡顶部的隐藏按钮以查看 Postman 将随您的请求发送的内容。

隐藏的标题

将鼠标悬停在标题上以查看其详细信息。邮递员会指出为什么添加了标题。如果需要,详细信息将指示如何停用或覆盖标头值。

主机头

停用或覆盖推荐的标头可能会使您的请求出现意外行为。

如果您需要更改标头,可以在 Postman 的相关部分中进行,例如Authorization选项卡、请求Body、请求域的Cookies 、 Settings,在某些情况下直接在Headers选项卡本身中进行。

令牌头

如果您需要导航到应用程序的不同部分,Postman 将在右侧显示一个链接。

如果已根据您的身份验证设置添加了标头,请导航到“授权”选项卡以更改它。

要更改 cookie 标头,请修改您将请求发送到的域的 cookie 设置。

要直接在Headers中停用自动生成的标题,请取消选中其复选框。要覆盖自动生成的标题值,请取消选中自动生成的条目并为标题添加单独的条目,在Key字段中列出其名称并在Value字段中指定您的值。

如果同一个标头有多个条目,Postman 将指示哪个将被覆盖,优先考虑您直接在Headers中显式添加的标头,或通过您在请求的其他部分(例如Authorization )中所做的选择间接添加的标头。

对于Content-LengthContent-Type标头,Postman 将在您发送请求时根据“正文”选项卡中的数据自动计算值。但是,您可以覆盖这两个值。

设置标头和其他请求详细信息后,您可以选择发送来运行您的请求。

使用 cookie

您可以从 Postman 管理您的域的 Cookie。选择发送按钮下的Cookie 。有关更多信息,请参阅管理 cookie

管理 cookie 对话框

选择自定义设置

您可以使用请求设置选项卡为 Postman 请求配置各种设置。这些允许您将非标准逻辑应用于您的请求。

编码您的请求 URL

Postman 解析和编码您的请求 URL,以最大限度地提高 API 调用成功的机会。Postman 对 URL 中的字符进行编码,并将它们映射到您的 API 最有可能接受的表示形式。Postman URL 处理器优化了您的请求被广泛使用的服务器实现有效处理的机会。

处理器将根据字符在 URL 中出现的位置对字符进行编码:

网址组件 要编码的字符
小路 " < > ` # ? { } SPACE
询问 " # & ' < = > SPACE
用户信息 " < > ` # ? { } / : ; = @ [ \ ] ^

默认情况下,处理器将在您的 Postman 应用程序中打开,但是如果您正在使用不寻常的服务器实现,您可以关闭编码。在您的请求设置>自动编码 URL中打开或关闭设置。

您可以通过突出显示文本并右键单击,然后选择EncodeURIComponent来选择性地对部分 URL 进行编码。

对您的请求进行故障排除

Postman 将在您的请求中可能无法按预期运行的部分中指出任何空格或无效字符,以便您可以更正您的值。您将看到请求方法、URL(包括路径)、参数、标头(包括您的键名)和正文中突出显示的字符。

无效字符

如果 Postman 无法发送您的请求或未收到响应,您将看到概述错误的详细信息。选择在控制台中查看以查看您的请求的概述并确定问题的根源。

如果您的请求未按预期工作,请查看一些故障排除提示

下一步

设置好请求后,选择Send并检查Response