API Mediation Layer.

This is a page about API Mediation Layer.

• Quick start 1-2-3
  • Build
    • Prerequisites for build
    • Build all modules
    • Unit tests
    • Measure code coverage
  • Run
    • Prerequisites for run
  • Use
    • Run integration tests
• Features
• Topics

Quick start 1-2-3

1. Build
2. Run
3. Use

Build

Prerequisites for build

Following platform is required to run the API Mediation Layer:

• Java Oracle or IBM Java SE Development Kit 8 (http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html or https://www.ibm.com/developerworks/java/jdk/), Java 10 is not supported.
• Node.js You should be able to run Node.js on your machine.

Build all modules

./gradlew build

Unit tests

Unit tests for Java and TypeScript modules are executed as a part of the build process.

Measure code coverage

For the code coverage of all modules, run:

./gradlew coverage

The code coverage for new code should be higher than 60% and should not be decreased for existing code.

The reports in HTML format are stored build/reports/jacoco/test/html/index.html for each Java module.

For the code coverage of a single Java module (for example discovery-service), run:

./gradlew :discovery-service:jacocoTestReport

You can an individual test class by:

./gradlew :discovery-service:test --tests com.ca.mfaas.discovery.staticdef.ServiceDefinitionProcessorTest

Run

Prerequisites for run

• concurrently You need to install concurrently globally:

npm install -g concurrently
Run all service on the local machine:
```shell
npm run api-layer

Use

Run integration tests

Follow the instructions in Integration Tests to run integration tests.

Features

Security

For more information about how the certificates between APIML services are set up, see TLS Certificates for localhost.

Topics

Contributor guidelines

Follow the guidelines in Contributing to add new functionality.

Local configuration of services

Follow the guidelines in Local Configuration to set local environment properties for testing on your local machine include HTTPS setup.

Also if you use IntelliJ IDEA, see learn how to configure Run Dashboard to use these local configurations.

Adding services that do not support API Mediation Layer natively

See Adding Services to API Gateway without Code Changes.

API Catalog UI

For more information about the UI of the Catalog see its README.

Yan collobarator