apiproxy

README

apiproxy

An APIBox middleware to proxy API request to backend API servers.

See full document at: https://go-apibox.github.io/docs/#!middlewares/apiproxy.md (Chinese)

Documentation

Index

• Variables
• type Backend
• type Proxy
  • func NewProxy(app *api.App) *Proxy
  • func (p *Proxy) AddBackend(alias string, backend *Backend)
  • func (p *Proxy) DeleteBackend(alias string)
  • func (p *Proxy) Disable()
  • func (p *Proxy) Enable()
  • func (p *Proxy) GetClient(alias string) *apiclient.Client
  • func (p *Proxy) ProxyCall(c *api.Context, backendAlias string, action string, params url.Values) (*apiclient.Response, *api.Error)
  • func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)
  • func (p *Proxy) SetClient(alias string, client *apiclient.Client)

Variables

var ErrorDefines = map[api.ErrorType]*api.ErrorDefine{
	// contains filtered or unexported fields
}

Types

type Backend

type Backend struct {
	GWURL            string
	GWADDR           string
	Method           string
	AppId            string
	SignKey          string
	NonceLength      int
	DefaultParams    map[string]string
	OverrideParams   map[string]string
	DeleteParams     []string
	MatchParams      map[string][]string
	SSHTunnelEnabled bool
	SSHClient        *apiclient.SSHClient
}

type Proxy

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

func NewProxy

func NewProxy(app *api.App) *Proxy

func (*Proxy) AddBackend

func (p *Proxy) AddBackend(alias string, backend *Backend)

AddBackend add a new backend to proxy.

func (*Proxy) DeleteBackend

func (p *Proxy) DeleteBackend(alias string)

DeleteBackend delete a backend from proxy.

func (*Proxy) Disable

func (p *Proxy) Disable()

Disable disable the middle ware.

func (*Proxy) Enable

func (p *Proxy) Enable()

Enable enable the middle ware.

func (*Proxy) GetClient

func (p *Proxy) GetClient(alias string) *apiclient.Client

GetClient return the backend client object.

func (*Proxy) ProxyCall

func (p *Proxy) ProxyCall(c *api.Context, backendAlias string, action string, params url.Values) (*apiclient.Response, *api.Error)

func (*Proxy) ServeHTTP

func (p *Proxy) ServeHTTP(w http.ResponseWriter, r *http.Request, next http.HandlerFunc)

func (*Proxy) SetClient

func (p *Proxy) SetClient(alias string, client *apiclient.Client)

SetClient set the backend client object.