Developing APIs with Gradle
You can develop APIs starting with an OpenAPI 3.0 definition and use the IBM z/OS Connect API provider Gradle plug-in to generate the API provider project files and the language copybooks that are required to implement the API.
From z/OS Connect V3.0.69.0, the supplied Gradle plug-in can be used to generate a complete API provider project, which can then be built and deployed into z/OS Connect. These APIs are then used to call your CICS® COBOL or PL/I channel and container applications.
See System requirements for the supported releases of the API provider Gradle plug-in
- An API Project that can be included in the build of an IBM z/OS Connect API image, which can be deployed to a container platform of your choice.
- Each API operation path in the original OpenAPI 3.0 definition and its associated request and response code mapping.
- The z/OS Assets required to call the z/OS program implementing the API and to transform the request and response data structures.
- A complete API provider project, which can be used to build a IBM z/OS Connect API image, which can be deployed to a container platform of your choice.
- A
WAR
file that can, alternatively, be deployed into an z/OS Connect native server to activate the API provider. - COBOL copybooks or PL/I include files that are used in the z/OS applications to read the API request data, implement the API logic, and construct the API response data.
In addition to creating your API provider, you should also establish connections between z/OS Connect server and the z subsystem. For more information about establishing connections to CICS, see Configuring an IPIC connection to CICS.