Kong API Client

kong-api-client

Description

This is a sdk, to the Kong Gateway Admin API https://konghq.com/solutions/gateway/ . The implemented endpoints are:

• Services
• Customers
• Plugins
• Routes

The version of the kong api, is 1.1.x described on https://docs.konghq.com/1.1.x/getting-started/introduction 

Is possible to find examples on the examples folder and a complete reference guide on the documentation folder.

How connect to the kong instance

 
let KongApi = require('../../index.js')
let config = {
    adminUrl: 'http://' + process.env.KONG_IP + ':8001'
}
let kong = new KongApi(config)
kong.init()

How save new service

 
let KongApi = require('../../index.js')
let config = {
    adminUrl: 'http://' + process.env.KONG_IP + ':8001'
}
let kong = new KongApi(config)
kong.init()
 
await kong.addService({
    protocol: 'http',
    host: 'www.test.com',
    port: 8080,
    name: 'test'
});
 

How update a service host

 
let KongApi = require('../../index.js')
let config = {
    adminUrl: 'http://' + process.env.KONG_IP + ':8001'
}
let kong = new KongApi(config)
kong.init()
 
await kong.updateService(testHostId, {
    host: "www.new-test.com"
});
 

Save a new customer

 
let KongApi = require('../../index.js')
let config = {
    adminUrl: 'http://' + process.env.KONG_IP + ':8001'
}
let kong = new KongApi(config)
kong.init()
 
await kong.addConsumer({
    username: 'my-username',
    custom_id: 'my-custom-id',
});
 

Complete documentation

Builder Api 

This is the block of documentations that will define the base objects that the lib will use and/or receive from kong.

Services Api 

In this block of documentations will be defined interact with the kong services using the lib.

Routes Api 

In this block of documentations will be defined interact with the kong routes using the lib.

Consumers Api 

In this block of documentations will be defined interact with the kong consumers using the lib.

Plugins Api 

In this block of documentations will be defined interact with the kong plugins using the lib.

Need fix

• Better error msg in case of offline kong server
• User jest expect throw on the tests

Road Map

• add unit tests
• builder
• add a dockerfile to up kong
• add the plugins on the consumers (auth)
• create the documentation
• main readme
• constructor
• domains
• routes
• consumers
• plugins
• add the custom exception
• add routes capable to add items (plugins, consumers)