DevOps Test Integrations and APIs and IBM® Rational® Software Architect Designer

With IBM® Rational® Software Architect Designer, you can design an organization's services, which include technical description, technical documentation, and links to other technical documentation. As a tester, you can pull this information into HCL DevOps Test Integrations and APIs (Test Integrations and APIs) by using a WSDL or WADL add operation and populate the Architecture School quickly and accurately. Test Integrations and APIs parses the added documents in a way that you can directly use them in your testing.

Before you begin

Install IBM® Rational® Software Architect Designer, Version 9.5.0 or later. For installation instructions, see Installing and updating IBM® Rational® Software Architect Designer.
Note: The processes of preparing for the integration and adding the transformed documents to Test Integrations and APIs projects are independent of each other. Hence, you can install IBM® Rational® Software Architect Designer on the same computer as Test Integrations and APIs or a different one.

About this task

The integration process involves two steps:

Preparing for the integration

The integration setup is handled in IBM® Rational® Software Architect Designer and the process involves creating model projects and then transforming them into WSDL or WADL documents.

Procedure

  1. In IBM® Rational® Software Architect Designer, create a model project or import an existing one. For details, see Before you begin section under "Creating UML models" in the IBM® Rational® Software Architect Designer documentation.
  2. Create a UML model of a web service or a REST service. For details, see Creating UML models in the IBM® Rational® Software Architect Designer documentation.
  3. Transform the model:
    • For web service models, select the extension that generates IBM® Rational® Software Architect Designer model elements in WSDL for Test Integrations and APIs and then run the transformation.
    • For REST service models, select the extension that generates IBM® Rational® Software Architect Designer model elements in WADL for Test Integrations and APIs and then run the transformation.

    The generated extension elements in the WADL and WSDL documents provide information about the IBM® Rational® Software Architect Designer project. For details about how to configure and run model transformations, see Transforming models in the IBM® Rational® Software Architect Designer documentation.

Results

The initial setup for the integration between Test Integrations and APIs and IBM® Rational® Software Architect Designer is ready.

What to do next

Adding WSDL and WADL documents as synchronization sources

Before you begin

Make sure you have the initial setup ready. See Preparing for the integration for details.

About this task

You can add a WSDL document or a WADL document (generated from IBM® Rational® Software Architect Designer extensions) to your Test Integrations and APIs project as an external synchronization source that can be synchronized with the project.

For information about adding WSDL and WADL documents as synchronization sources, see Adding a WSDL document as a synchronization source and Adding a WADL document as a synchronization source.

Results

Test Integrations and APIs parses the IBM® Rational® Software Architect Designer extensions from the WSDL and WADL documents. It then populates the information into the Documentation tab of either the Service Component or the Environment that you create or select during the process. For sample WADL and WSDL fragments, and screen shots, see Examples: IBM Rational Software Architect Designer extensions.