kong

Documentation

Overview

///////////////////////////////////////////////////////////////////// Copyright (c) 2017 VMware, Inc. All Rights Reserved. SPDX-License-Identifier: Apache-2.0 /////////////////////////////////////////////////////////////////////

Index

• type API
• type Client
  • func NewClient(config *Config) (*Client, error)
  • func (k *Client) AddAPI(entity *gateway.API) (*gateway.API, error)
  • func (k *Client) DeleteAPI(api *gateway.API) error
  • func (k *Client) GetAPI(name string) (*gateway.API, error)
  • func (k *Client) Initialize() error
  • func (k *Client) UpdateAPI(name string, entity *gateway.API) (*gateway.API, error)
• type Config
• type Plugin

Types

type API

type API struct {

	// id and created_at is required to update an kong API
	ID        string `json:"id,omitempty"`
	CreatedAt int    `json:"created_at,omitempty"`

	Name        string   `json:"name"`
	UpstreamURL string   `json:"upstream_url,omitempty"`
	URIs        []string `json:"uris,omitempty"`
	Hosts       []string `json:"hosts,omitempty"`
	Methods     []string `json:"methods,omitempty"`
	HTTPSOnly   bool     `json:"https_only,omitempty"`
}

API is a struct for Kong API

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a http client connecting to a Kong server

func NewClient

func NewClient(config *Config) (*Client, error)

NewClient creates a new Kong Client

func (*Client) AddAPI

func (k *Client) AddAPI(entity *gateway.API) (*gateway.API, error)

AddAPI add an API in Kong

func (*Client) DeleteAPI

func (k *Client) DeleteAPI(api *gateway.API) error

DeleteAPI delete an API from Kong

func (*Client) GetAPI

func (k *Client) GetAPI(name string) (*gateway.API, error)

GetAPI get an API from Kong

func (*Client) Initialize

func (k *Client) Initialize() error

Initialize install neccessary plugins into kong at the begining

func (*Client) UpdateAPI

func (k *Client) UpdateAPI(name string, entity *gateway.API) (*gateway.API, error)

UpdateAPI updates an API in Kong

type Config

type Config struct {
	Host     string
	Upstream string
}

Config represents a configure for Kong Client

type Plugin

type Plugin struct {
	Name    string                 `json:"name"`
	ID      string                 `json:"id,omitempty"`
	Config  map[string]interface{} `json:"config,omitempty"`
	Enabled bool                   `json:"enabled,omitempty"`
}

Plugin is a struct for Kong Plugin