KONG - The API Layer

Kong is a scalable and customizable API Management Layer built on top of Nginx.

Note: getkong.org is still a work in progress, in the meanwhile, please follow instructions in this README instead.

• Installation
• Documentation
• Usage
• Development

Installation

See INSTALL.md for installation instructions on your platform.

Documentation

A complete documentation on how to configure and use Kong can be found at: getkong.org/docs. (coming soon)

Usage

Use Kong through the kong executable. If you installed Kong via luarocks (as previously instructed) then kong should be in your $PATH.

$ kong --help

To start Kong (make sure your Cassandra instance is running):

$ kong start

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