PhpStorm内置的REST客户端 使用方法

来源:互联网 发布:数据库的日志不可用 编辑:程序博客网 时间:2024/05/29 13:26

http://confluence.jetbrains.com/display/PhpStorm/Built-in+REST+Client+in+PhpStorm


跳到元数据结束转到元数据的开始
 

建立一个REST API?需要测试对Web应用程序的调用?在构建基于REST的Web API时,值得拥有一个可用于调用和测试的工具,以查看对我们的请求的响应。在本教程中,我们将看看PhpStorm中的内置REST客户端。

  • 创建一个HTTP请求
    • 生成授权标题
    • 饼干
  • 重新使用请求
    • 最近的请求
    • 导入和导出请求重新使用
  • 配置代理设置

创建一个HTTP请求

REST客户端可以在Tools |下找到 测试REST风格的Web服务菜单。它打开一个新的工具窗口,我们可以创建HTTP请求,我们可以调用并检查结果。

在REST Client工具窗口中,我们可以指定HTTP方法,要连接的主机和端口(IP地址或主机名,本地和Internet),我们要发送请求的路径,标题,请求参数和请求体。现在我们跳过所有这些,并创建一个GET请求到“http://www.google.com”。请注意,如果我们想要发送cookie,我们可以在Cookies选项卡中制作这些cookie

当我们点击工具栏中运行按钮(或者按下Ctrl + Enter)时,请求将被执行,响应标签将会打开。在那里,我们可以看到响应正文为HTML,XML,JSON或“原始”,没有任何格式。我们也可以将其导出到一个文件或在浏览器中打开它。

以下是返回JSON的响应示例:

 Cookies”选项卡向我们显示远程服务器返回的所有Cookie的密钥和值。这些cookie可以被修改或删除,并在随后的请求中被发送到服务器。

如果我们对响应标题感兴趣,我们可以在响应标题选项卡中看到

生成授权标题

有些端点将需要授权。我们可以在构建我们的请求时手动添加授权标头。例如,在使用需要OAuth载体令牌的服务时,我们可以将其添加到我们的请求中:

对于基本身份验证,PhpStorm可以为我们生成头文件。单击工具栏中的“ 生成授权标题”图标可让我们输入IDE将为其生成基本身份验证标头的用户名和密码。

饼干

正如我们在前面的例子中看到的那样,远程服务器返回的cookie将在Cookies选项卡下可见,并且可以被编辑。如果需要测试服务,我们也可以添加我们自己的cookie值。

单击+图标或按Alt + InsertMac OS X上的CMD + N)将添加一个新的cookie条目,我们可以在其中提供:

  • Cookie的名称
  • cookie的价值
  • 该cookie有效的域
  • Cookie的有效路径
  • cookie的有效期限

当我们的REST服务要求存在特定的cookie或使用cookie来了解会话数据时,这非常方便。

图标

内置REST客户端支持创建cookie并从服务器响应中添加cookie的事实在创建针对使用会话的服务器的请求时非常有用。例如,当一个基于PHP的端点使用session_start(),然后利用会话数据时,标识用户的cookie将被存储起来,并在随后的请求中发送回服务器。

重新使用请求

PhpStorm在打开时会跟踪使用内置REST客户端发出的请求。先前执行的请求可以再次运行,我们也可以导入/导出请求。

最近的请求

当一个HTTP请求被执行时,REST客户端将从工具栏上Recent Requests列表中保持可用状态我们可以重放过去发出的HTTP请求,使得更容易处理一系列HTTP请求并在它们之间切换。

点击以前的请求将填充请求Cookie选项卡,并使用之前使用的值。

导入和导出请求重新使用

每个通过内置REST客户端创建的HTTP请求都可以在稍后导出和导入。这使我们能够在需要的时候创建一系列可以在开发过程中使用的HTTP请求。创建一次,导出和重用。导出HTTP请求可以从工具栏完成。

请求存储在一个XML文件中,我们可以编辑,如果需要的话。我们也可以将这些导出的请求添加到VCS,以便团队成员在开发或测试某些特定功能时可以从中受益。以下是一个导出的请求示例,用于查询JetBrains GitHub组织中是否包含单词“PhpStorm”的代码:

<RestClientRequest>
  <option name="biscuits">
    <list />
  </option>
  <option name="httpMethod" value="GET" />
  <option name="urlBase" value="https://api.github.com" />
  <option name="urlPath" value="/search/code" />
  <option name="headers">
    <list>
      <KeyValuePair>
        <option name="key" value="Accept" />
        <option name="value" value="application/json" />
      </KeyValuePair>
      <KeyValuePair>
        <option name="key" value="Cache-Control" />
        <option name="value" value="no-cache" />
      </KeyValuePair>
    </list>
  </option>
  <option name="parameters">
    <list>
      <KeyValuePair>
        <option name="key" value="q" />
        <option name="value" value="PhpStorm user:jetbrains" />
      </KeyValuePair>
    </list>
  </option>
  <option name="parametersEnabled" value="true" />
  <option name="haveTextToSend" value="false" />
  <option name="haveFileToSend" value="false" />
  <option name="isFileUpload" value="false" />
  <option name="textToSend" value="" />
  <option name="filesToSend" value="" />
</RestClientRequest>
图标

PhpStorm的开发者有很大的幽默感!请求的Cookies存储在<option name =“biscuits”/>元素中。

导入保存的请求也可以从工具栏完成。我们所要做的只是选择文件,PhpStorm将更新请求Cookies选项卡与来自保存的请求的请求参数。

图标

在构建API时,生成一堆示例HTTP请求并将其与我们的项目一起分发是非常方便的。我们的API的团队成员和消费者可以使用这些来从他们的IDE运行示例请求。

配置代理设置

如果必须使用代理服务器连接到我们要测试的主机,我们可以通过单击工具栏中“设置”图标来配置它这将弹出一个对话框,我们可以在其中指定代理服务器设置。

PhpStorm支持自动发现代理服务器,可以同时使用HTTP和SOCKS代理服务器,包括那些需要认证的服务器。

原创粉丝点击