KONG - The API Layer

Kong is a scalable, open-source Management Layer for APIs and Microservices. Built on top of NGINX with focus on high performance and reliability.

Why Kong

We used to write custom code for each service. With Kong we write once, dispatch everywhere.

Table of Contents

1. Installation
2. Documentation
3. Usage
4. Development
5. Makefile Operations

Installation

1. Download: http://getkong.org/download
2. Run kong start

Note: Kong requires Cassandra 2.1.3

Documentation

Visit getkong.org for the official Kong documentation.

Usage

Use Kong through the kong CLI:

$ kong --help

Note If you installed Kong via one of the available methods, then kong should already be in your $PATH.

Development

1. Clone the repository and make it your working directory.
2. Run [sudo] make install

This will build and install the kong luarock globally.

3. Run make dev

This will install development dependencies and create your environment configuration files:

• kong_TESTS.yml
• kong_DEVELOPMENT.yml

4. Run the tests:

make test-all

5. Run Kong with the development configuration file:

   $ kong start -c kong_DEVELOPMENT.yml

Makefile Operations

When developing, use the Makefile for doing the following operations:

Name	Description
install	Install the Kong luarock globally
dev	Setup your development environment
run	Run the DEVELOPMENT environment (kong_DEVELOPMENT.yml)
seed	Seed the DEVELOPMENT environment (kong_DEVELOPMENT.yml)
drop	Drop the DEVELOPMENT environment (kong_DEVELOPMENT.yml)
lint	Lint Lua files in kong/
coverage	Run unit tests + coverage report (only unit-tested modules)
test	Run the unit tests
test-all	Run all unit + integration tests at once