配置通用任务服务器

最后修改时间：2021 年 8 月 26 日

PhpStorm 支持与许多开箱即用的任务跟踪器集成。但是，如果您使用 PhpStorm 尚不支持的跟踪器，您仍然可以将其集成以配置所谓的通用服务器。

本教程介绍如何：

  • 作为通用服务器连接到 JIRA Cloud。

  • 获取分配给您的问题列表。

  • 对于每个问题，获取其 ID、标题、描述、创建和更新问题的日期和时间。

在开始配置与跟踪器的连接之前，请注意 PhpStorm：

  • 仅支持带有 REST API 的服务。

  • 支持基本 HTTP 身份验证或向服务器发送初步请求。

  • 支持 GET 和 POST 请求。

  • 不支持服务器响应中的分页。

指定服务器 URL 和凭据

  1. 在设置/首选项对话框Ctrl+Alt+S中，转到工具 | 任务 | 服务器。

  2. 单击添加按钮并选择通用。

  3. 在常规选项卡上，指定任务跟踪器的 URL 和连接凭据。

    在用户名字段中，输入您的电子邮件地址。

    在密码字段中，输入您的Atlassian API 令牌。

  4. 选中对话框底部的使用 HTTP 身份验证复选框。

指定服务器 URL 和凭据

配置服务器设置

  1. 切换到服务器配置选项卡。

    请注意，登录 URL字段将被禁用，因为您正在使用 HTTP 身份验证。

  2. 在Tasks List URL中，输入用于从服务器获取问题的 URL。您可以使用变量或输入完整的 URL：

    {serverUrl}/rest/api/2/search或https://serverurl.atlassian.net/rest/api/2/search

    这是一个变量，代表您在“常规{serverUrl}”选项卡上指定的 URL 。

  3. 将?jql={JQL_Query}表达式添加到您的任务列表 URL：{serverUrl}/rest/api/2/search?jql={JQL_Query}。

    tip

    您可以在Login URL、Tasks List URL和Single Task URL字段中使用代码完成。

    配置服务器设置

  4. 单击对话框底部的管理模板变量JQL_Query以配置变量。

  5. 单击添加按钮并在新字段中，指定变量名称JQL_Query并添加其值assignee = currentUser() AND resolution = unresolved。

    这将使您获得分配给您的未解决问题。

  6. 单击确定。

    指定模板变量

note

URL 字段中指定的所有变量，除了{serverUrl}，默认情况下都使用编码application/x-www-form-urlencoded。

tip

有关如何进行高级搜索的更多信息，请参阅高级搜索 - 字段参考。

配置响应类型并指定选择器

  1. 在“服务器配置”对话框中，选择JSON响应类型。

  2. 在表中指定选择器以获取问题的 ID 和标题及其描述。您还可以获得创建和更新问题的日期和时间：

    • 任务：$.issues

    • ID：key

    • 概括：fields.summary

    • 描述：fields.description

    • 更新：fields.updated

    • 创建：fields.created

    tip

    对于 JIRA，您可以实时检查服务器响应。将链接中的占位符替换为实际值并在浏览器中打开：http://<serverURL>:<port>/rest/api/2/search

  3. 单击测试以确保所有参数均已正确配置。

    配置响应类型并指定选择器

从服务器上传问题

  1. 单击任务组合并选择打开任务。PhpStorm 将从服务器加载与您的配置匹配的所有问题。

  2. 从列表中选择必要的问题。

  3. 按Ctrl+Q打开问题描述并确保获得所有必需的详细信息。