Quick Start for Development

To validate that a service is working properly with the API Mediation Layer, you first need to have a running instance of API Mediation Layer. Choose from the following options:

• Install Zowe and validate against a Zowe instance of API Mediation Layer
  • For this setup you can either run Zowe without certificates, or preferably with certificates generated by installation in the keystore. Note that this applies strictly to an installed Zowe runtime (using SAF keyrings, zowe.yaml configuration, or z/OS certificates) and is distinct from the local source development certificate workflow.
• Run API Mediation Layer in Codespace or on a local machine directly.
  • The details are available in API Mediation Layer repository. When running via Gradle tasks (such as test or Jib tasks), single-purpose local certificates are generated automatically. However, for direct launches using IDEs, npm, or sample applications that bypass Gradle, you must explicitly run ./gradlew generateCertificates before starting the services.
• Run API Mediation Layer in containers.
  • The details are available in the README API Mediation Layer in container.
• Run API Mediation Layer as Java services on z/OS.
  • This approach is not documented, but is possible. To run API ML as Java services on z/OS, it is necessary to build the services first, and then upload these services to the mainframe.

To learn more about the certificate setup options for API Mediation Layer with respect to the Development purposes, including local on-demand certificate generation, artifact path updates, and single-purpose identity details, consult Certificate Management in Zowe API Mediation Layer and the keystore/README.md.