KONG - The API Layer

Kong is an open distributed platform for your APIs, built on top of nginx it's focused on high performance and reliability.

Official website at getkong.org

• Installation
• Documentation
• Usage
• Development

Installation

To install Kong, please follow the instructions at getkong.org/download

Documentation

Official documentation can be found at getkong.org/docs/

Usage

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

$ kong --help

Development

To develop for Kong, simply run [sudo] make install in a clone of this repo. Then run:

$ make dev

This will install development dependencies and create your environment configuration files (kong_TESTS.yml and kong_DEVELOPMENT.yml).

• Run the tests:

$ make test-all

• Run Kong with the development configuration:

$ kong start -c kong_DEVELOPMENT.yml

Makefile

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 src/
coverage	Run unit tests + coverage report (only unit-tested modules)
test	Run the unit tests
test-proxy	Run the proxy integration tests
test-server	Run the server integration tests
test-api	Run the api integration tests
test-all	Run all unit + integration tests at once