Kong is a scalable and customizable API Management Layer built on top of nginx.
See INSTALL.md for installation instructions on your platform.
A complete documentation can be found at: getkong.org/docs
Use Kong through the bin/kong executable. Make sure your Cassandra instance is running.
The first time ever you're running Kong, you need to make sure to setup Cassandra by executing:
bin/kong migrateTo start Kong:
bin/kong startSee all the available options, with bin/kong -h.
Running Kong for development requires you to run:
make dev
This will create your environment configuration files (dev and tests). Setup your database access for each of these enviroments (be careful about keyspaces, since Kong already uses kong and unit tests already use kong_tests).
- Run the tests:
make test-all
- Run it:
bin/kong -c config.dev/kong.yml -n config.dev/nginx.conf start
When developing, use the Makefile for doing the following operations:
| Name | Description |
|---|---|
install |
Install the Kong luarock globally |
dev |
Setup your development enviroment (creates config.dev and config.tests configurations) |
clean |
Clean the development environment |
migrate |
Migrate your database schema according to the development Kong config inside config.dev |
reset |
Reset your database schema according to the development Kong config inside config.dev |
seed |
Seed your database according to the development Kong config inside config.dev |
drop |
Drop your database according to the development Kong config inside config.dev |
test |
Run the unit tests |
test-proxy |
Run the proxy integration tests |
test-web |
Run the web integration tests |
test-all |
Run all unit + integration tests at once |
Those scripts provide handy features while developing Kong:
# Complete usage
scripts/db.lua --help
# Migrate up
scripts/db.lua migrate [configuration_path] # for all commands, the default configuration_path is config.dev/kong.yml
# Migrate down (currently equivalent to reset)
scripts/db.lua rollback
# Reset DB (danger!)
scripts/db.lua reset
# Seed DB
scripts/db.lua seed
# Drop DB (danger!)
scripts/db.lua drop