What is the z/OS Connect API toolkit?

The z/OS Connect API toolkit is an Eclipse-based workstation tool that you install into IBM® Explorer for z/OS to create services and REST APIs for accessing z/OS resources.

zosConnect-2.0 Applies to zosConnect-2.0.

Note: The z/OS Connect API toolkit cannot be used to create API requesters, nor does it display or manage the API requesters that are deployed on the z/OS Connect Server.
  • The IBM z/OS Connect zosConnect-2.0 3.0 API toolkit simplifies the definition and deployment of application services for CICS® and IMS environments. Previously known as the z/OS Connect API editor in V2, the z/OS Connect API toolkit now provides more functions for service creation.
  • The API toolkit provides a new type of project for services to complement the API projects, enabling end-to-end creation of z/OS Connect API and dependent services from within the same Eclipse-based environment.
  • The new service projects that are introduced with the Service Interface Editor in the API toolkit, increase the number of eligible z/OS-based applications that can be API-enabled to include those with complex data structures, such as REDEFINES and OCCURS DEPENDING ON clauses for COBOL, and REFER in PL/I. See COBOL to JSON schema mapping and PL/I to JSON schema mapping.
  • The Service Interface Editor in the API toolkit enables the creator of the service project to perform renaming, redaction, and remarking for data fields that are used at the service level, encapsulating unique working knowledge of the target business logic that can greatly assist API creators to understand and use the true value of underlying services. See Customizing the service interface.

In the z/OS Connect API toolkit, you can create two types of projects: service projects and API projects.

Service projects and service creation

You can create a CICS, IMS, Db2®, or IBM MQ service in an z/OS Connect service project.

For Db2, the provided service project editor guides you through the steps to import a Db2 native REST service definition from Db2.

For CICS, IMS, and IBM MQ, the provided service project editor and service interface editor guide you through the steps to import COBOL copybooks, PL/I include files, or full programs and to customize the service interface. The service interface defines what fields to expose and how they are exposed in the service.

  • Fields and data structures can be renamed and remarks can be added, allowing API creators to better understand and use the underlying services.
  • Fields can be excluded from the interface.
  • Data structures can be duplicated and the order can be adjusted (order is important for IMS segments).
  • Complex data structures such as REDEFINES and OCCURS DEPENDING ON clauses for COBOL and REFER in PL/I are supported.

    Figure 1. Defining the service interface
    The service interface editor in API toolkit.
Defined services can be exported as a service archive for deployment.

API projects and API creation

You can create REST APIs from any service archives in a z/OS Connect API project. An API editor and a mapping editor are included to help you model and create the APIs for your z/OS Connect services.

  • Create your API by specifying the path, query, and header parameters in the API editor.
    Figure 2. API editor
    The service interface editor in API toolkit.
  • Define how the path, query, and header parameters map to fields in the JavaScript Object Notation (JSON) schema of your service.
    Figure 3. Mapping editor
    The mapping editor in API toolkit.
  • View services on connected servers.
  • Deploy APIs to the servers.
  • Visually inspect the APIs in the embedded Swagger UI.
  • Start and stop the APIs.
  • Immediately test the APIs directly from the editor.