Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zowe/api-layer
The API Mediation Layer provides a single point of access for mainframe service REST APIs.
https://github.com/zowe/api-layer
api-catalog api-gateway certificate java mainframe rest-api
Last synced: 3 days ago
JSON representation
The API Mediation Layer provides a single point of access for mainframe service REST APIs.
- Host: GitHub
- URL: https://github.com/zowe/api-layer
- Owner: zowe
- License: epl-2.0
- Created: 2018-10-30T12:42:00.000Z (over 6 years ago)
- Default Branch: v3.x.x
- Last Pushed: 2025-02-06T19:30:22.000Z (8 days ago)
- Last Synced: 2025-02-06T20:42:45.698Z (8 days ago)
- Topics: api-catalog, api-gateway, certificate, java, mainframe, rest-api
- Language: Java
- Homepage:
- Size: 47.9 MB
- Stars: 57
- Watchers: 20
- Forks: 65
- Open Issues: 147
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# API Mediation Layer
[Workflows status overview](WORKFLOWS_STATUS_OVERVIEW.MD)
The API Mediation Layer (API ML) provides a single point of access for mainframe service REST APIs. The API ML offers enterprise, cloud-like features such as high-availability, scalability, dynamic API discovery, consistent security, a single sign-on experience, and documentation. The API ML consists of three components: the Gateway, the Discovery Service, and the API Catalog. The API ML facilitates secure communication across loosely coupled microservices through the API Gateway. The Discovery Service enables you to determine the location and status of service instances running inside the API ML ecosystem. The API Catalog provides a user-friendly, easy-to-use interface to view all discovered services, their associated APIs, and Swagger documentation.
**Notes:**
* For more general information for end-users, see the API ML [Overview](https://docs.zowe.org/stable/getting-started/overview.html#api-mediation-layer).
* To learn more about changes to the API ML, consult the [CHANGELOG](CHANGELOG.md).
* For developers, review the [developer documentation](./docs) and the [Contributor guidelines](#contributor-guidelines).
## Contents
* [Run API Mediation Layer locally](#run-api-mediation-layer-locally)
* [Prerequisites](#prerequisites)
* [Quick start](#quick-start)
* [Security](#security)
* [Run integration tests](#run-integration-tests)
* [Certificates](#certificates)
* [Contributor guidelines](#contributor-guidelines)
* [Local configuration of services](#local-configuration-of-services)
* [Onboarding Services](#onboarding-services)
* [More Information](#more-information)
* [Contact Us](#contact-us)
## Run API Mediation Layer locally
### Prerequisites
The following platform is required to run the API Mediation Layer:
* [IBM Semeru JDK](https://developer.ibm.com/languages/java/semeru-runtimes/downloads/) Java 17 or later
The following tools are required to build and develop the API Mediation Layer:
* Node.js and npm are required to be installed globally to run npm commands in project root folder.
*
* During build, correct node version is automatically downloaded and built with.
### Quick start
**Follow these steps:**
1. Build all modules:
```sh
./gradlew build
```
2. Install the same version of the `concurrently` globally:
```sh
npm install -g concurrently@^6.0.0
```
3. Run all service on your local machine:
```sh
npm run api-layer
```
## Security
By default, the API Mediation Layer for local development uses mock zOSMF as the authentication provider. For development purposes, log in using the default setting `USER` for the username, and `validPassword` as the password
The API Mediation Layer can also use dummy credentials for development purposes. For development purposes, log in using the default setting `user` for the username, and `user` as the password.
Configure dummy credentials provider
### Configure `dummy` credentials provider
Modify [gateway-service.yml](/config/local/gateway-service.yml)
```yaml
apiml:
security:
auth:
#provider: zosmf
provider: dummy
```
For more information, see [API Mediation Layer Security](https://docs.zowe.org/stable/extend/extend-apiml/zowe-api-mediation-layer-security-overview).
## Run integration tests
To run integration tests, follow the instructions in [Integration Tests](integration-tests/README.md).
## Certificates
For more information about how the certificates between API ML services are set up for localhost, see [TLS Certificates for localhost](keystore/README.md).
## Contributor guidelines
To add new functionality, follow the guidelines in [Contributing](CONTRIBUTING.md).
## Local configuration of services
To set local environment properties for testing on your local machine including HTTPS setup, follow the guidelines in [Local Configuration](docs/local-configuration.md).
Review [IDE setup](docs/ide-setup.md) to see how to configure popular IDEs for API ML development.
## Onboarding Services
For guidelines to onboard services, see [Zowe Docs#Onboarding Overview](https://docs.zowe.org/stable/extend/extend-apiml/onboard-overview.html).
## More Information
| To learn about: | Refer to: |
|---------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------|
| Core Service - API Catalog | [Zowe Docs](https://docs.zowe.org/stable/getting-started/overview.html#api-mediation-layer) |
| Core Service - API Catalog UI | [README](api-catalog-ui/frontend/README.md) |
| Core Service - Discovery Service | [Zowe Docs](https://docs.zowe.org/stable/getting-started/overview.html#api-mediation-layer) |
| Core Service - Gateway Service | [Zowe Docs](https://docs.zowe.org/stable/getting-started/overview.html#api-mediation-layer) |
| APIML SDK - Java Enabler | [Zowe Docs](https://docs.zowe.org/stable/extend/extend-apiml/onboard-plain-java-enabler) |
| APIML SDK - Micronaut Enabler | [Zowe Docs](https://docs.zowe.org/stable/extend/extend-apiml/onboard-micronaut-enabler) |
| APIML SDK - Node.js Enabler | [Zowe Docs](https://docs.zowe.org/stable/extend/extend-apiml/onboard-nodejs-enabler) |
| APIML SDK - Spring Enabler | [Zowe Docs](https://docs.zowe.org/stable/extend/extend-apiml/onboard-spring-boot-enabler) |
| APIML SDK - ZAAS Client | [Zowe Docs](https://docs.zowe.org/stable/extend/extend-apiml/api-mediation-security/#zaas-client) | |
| Sample Service - Spring Enabler | [README](onboarding-enabler-spring-sample-app/README.md) |
| Sample Service - Micronaut Enabler | [README](onboarding-enabler-micronaut-sample-app/README.md) |
| Sample Service - NodeJS Enabler | [README](onboarding-enabler-nodejs-sample-app/README.md) |
## Contact Us
Get in touch using [Zowe Communication Channels](https://github.com/zowe/community/blob/master/README.md#communication-channels). You can find us in the `#zowe-api` channel on Slack.