Giter Club home page Giter Club logo

api-layer's Introduction

API Mediation Layer.

This is a page about API Mediation Layer.

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:

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

api-layer's People

Contributors

plavjanik avatar giza-jenkins avatar oupvo01 avatar jirkaaichler avatar taban03 avatar zowe-robot avatar markackert avatar czikos avatar vsev0lod avatar melva02 avatar dkelosky avatar trode05 avatar startup-engineer avatar stevenhorsman avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.