使用模式发现向导添加 REST 数据源模式

可以为 REST 数据源创建数据源模式。创建模式可以简化针对具有相同结构以及相同或相似属性列表的模块编写文档模板的过程。

关于此任务

使用“模式发现”向导来创建数据源模式时,可以从应用程序可能支持的两个可报告 REST 选项(REST API 1.0 或 REST API 2.0)中选择。如果不知道应用程序所支持的 REST API 版本,请与系统管理员联系。

模式发现 (REST API 1.0)

关于此任务

注: 完成此任务以使用数据服务应用程序来帮助在 Rational® Team Concert 和数据源中查找模式。对于其他基于 REST 的应用程序,请参阅产品文档以了解有关生成模式的信息。

过程

  1. 在 Document Studio 中,单击数据 > 模式发现 > REST 模式发现
  2. 指定连接详细信息:
    1. 名称:输入数据源的名称。
    2. 描述:输入数据源的描述。
    3. 基本 URL:指定资源的基本 URL。
    4. 认证类型:从列表中选择认证类型。
    5. 用户:如果资源位于受保护的服务器,请指定用户名。
    6. 密码:如果资源位于受保护的服务器,请指定密码。
  3. 单击下一步
  4. 在“创建资源”窗口中,指定新资源的详细信息:
    1. 名称:输入新资源的名称。
    2. 描述:输入新资源的描述。
    3. 相对路径:输入新资源的相对路径。
    如果可通过报告数据服务适配器访问 REST 数据源,请选择使用数据服务进行定位来定位资源。具有 href 属性的资源可以进行资源浏览。展开列表以查找资源。
  5. 要选择资源,请执行下列操作:
    1. 在 XML 模式树中选择一个元素。
    2. 从属性列表中选择 href 值。
    3. 单击下一步。此时,会显示所选资源的资源 URL。
  6. 选择 URL 并单击完成,或者使用 URL 来定位子资源。要定位子资源,请执行下列操作:
    1. 选择资源 URL 并单击下一步
    2. 在 XML 模式树中选择一个元素。
    3. 从属性列表中选择 href 值。
  7. 单击完成。此时,向导会完成,并且 URL 会显示在“配置”窗口中。如果资源位于受保护的服务器上,请在“配置”窗口中输入用户名和密码。

下一步做什么

将此模式添加至模板。请参阅添加数据源模式

模式发现 (REST API 2.0)

关于此任务

注: Rational Publishing Engine 仅支持缩写的 RDF。提供者必须接受并采用 application/xml 请求。请参阅 Open Services for Lifecycle Collaboration Core Specification V 2.0
Rational Publishing Engine 仅支持遵循可报告 REST V2 规范的 OSLC V2 提供者。
  • OSLC 服务必须在预期用于报告的所有资源的服务资源中定义查询功能。
  • 用于报告的每项查询功能:
    • 必须让 oslc:queryBase 指向资源,该资源具有预期用于报告的资源列表。在列表资源的资源形状资源中,必须将列表中的资源标识为 oslc:isMemberProperty
    • 必须具有 oslc:resourceShape 以描述列表资源。

过程

  1. 单击数据 > 模式发现 > REST V2 模式发现
  2. 指定连接详细信息:
    1. 基本 URL:指定资源的基本 URL。
      必须知道要接受的服务提供者的 URL。此 URL 是可报告 REST 数据源的数据服务应用程序 URL 的等效件。Rational Publishing Engine 以查询列表的形式从数据源访存数据。可以从中查询和解释数据的服务会存储这些资源。该服务也提供查询服务来帮助依照设定的条件进行数据过滤,或者帮助优化数据子集。这些查询适用于一种资源,并且可让您访问特定类型的资源。可报告 ID2 服务可以显示许多资源类型,例如产品或用户变更请求。查询服务帮助用户有效地检索数据或数据子集,但不是必需的。查询服务适用于所有资源。每个产品都可以定义其资源以及访问这些资源的查询。
    2. 认证类型:从列表中选择认证类型。
    3. 用户:如果资源位于受保护的服务器,请指定用户名。
    4. 密码:如果资源位于受保护的服务器,请指定密码。
  3. 单击下一步
  4. 选择 REST V2 服务及其相应的查询,然后单击下一步 此时,会显示所选服务的属性。
  5. 从列表中选择必需的属性,然后单击测试 oslc.select 此时,“结果确认”窗口会显示所选服务。请确认服务是否正确。如果单击正确,那么测试 oslc.select 字段状态会更改为 true。单击下一步

    通常不使用测试 oslc.properties 字段。

  6. 查询包含 oslc.where 子句查询包含 oslc.orderBy 子句中,只能输入查询的过滤器或排序子句,例如 cq:Product{cq:Product=“Rational Publishing Engine”}
  7. 单击测试 oslc.where 测试 oslc.orderBy 以验证连接。 Rational Publishing Engine 使用定义的选项来创建完整请求。
  8. 单击下一步。此时,会显示查询的摘要。单击完成。此时,向导会完成,并且 URL 会显示在“配置”窗口中。如果资源位于受保护的服务器上,那么可以在“配置”窗口中提供用户名和密码。

反馈