gateway

Documentation

Index

• func DefaultFormBodyFunc(c *api.Context, _ []BuilderRequest, _ map[string]any) (any, error)
• func DefaultFormHeadersFunc(c *api.Context, _ []BuilderRequest, _ map[string]any) (map[string]string, error)
• func DefaultFormPathParamsFunc(c *api.Context, _ []BuilderRequest, _ map[string]any) (map[string]string, error)
• func DefaultFormQueryParamsFunc(c *api.Context, _ []BuilderRequest, _ map[string]any) (map[string]string, error)
• func DestroyGateway(gw *Gateway)
• type Builder
  • func (builder *Builder) Build(middlewares ...api.Handler)
  • func (builder *Builder) Delete(request *DeleteRequest, requestCallbackFunc RequestCallbackFunc) *Builder
  • func (builder *Builder) Get(request *GetRequest, requestCallbackFunc RequestCallbackFunc) *Builder
  • func (builder *Builder) GlobalRequestCallbackFunc(globalRequestCallbackFunc GlobalRequestCallbackFunc) *Builder
  • func (builder *Builder) Post(request *PostRequest, requestCallbackFunc RequestCallbackFunc) *Builder
  • func (builder *Builder) PostStruct(request *PostRequest, requestCallbackFunc RequestCallbackFunc) *Builder
  • func (builder *Builder) Put(request *PutRequest, requestCallbackFunc RequestCallbackFunc) *Builder
  • func (builder *Builder) ResponseErrorFunc(responseErrorFunc ResponseErrorFunc) *Builder
  • func (builder *Builder) ResponseSuccessFunc(responseSuccessFunc ResponseSuccessFunc) *Builder
  • func (builder *Builder) Url(httpMethod string, relativePath string) *Builder
• type BuilderRequest
• type DeleteRequest
  • func (req *DeleteRequest) HttpMethod() string
  • func (req *DeleteRequest) Request(c *api.Context, request *http_client.Request, historyRequests []BuilderRequest, ...) error
  • func (req *DeleteRequest) RequestUrl() string
  • func (req *DeleteRequest) Response() *http_client.Response
• type FormBodyFunc
• type FormHeadersFunc
• type FormPathParamsFunc
• type FormQueryParamsFunc
• type Gateway
  • func NewGateway(api *api.Api, opts ...Option) *Gateway
  • func (gw *Gateway) NewBuilder(routerType string, version string) *Builder
• type GetRequest
  • func (req *GetRequest) HttpMethod() string
  • func (req *GetRequest) Request(c *api.Context, request *http_client.Request, historyRequests []BuilderRequest, ...) error
  • func (req *GetRequest) RequestUrl() string
  • func (req *GetRequest) Response() *http_client.Response
• type GlobalRequestCallbackFunc
• type Option
  • func WithHttpClientTimeoutSec(httpClientTimeoutSec int64) Option
• type Options
• type PostRequest
  • func (req *PostRequest) HttpMethod() string
  • func (req *PostRequest) Request(c *api.Context, request *http_client.Request, historyRequests []BuilderRequest, ...) error
  • func (req *PostRequest) RequestUrl() string
  • func (req *PostRequest) Response() *http_client.Response
• type PutRequest
  • func (req *PutRequest) HttpMethod() string
  • func (req *PutRequest) Request(c *api.Context, request *http_client.Request, historyRequests []BuilderRequest, ...) error
  • func (req *PutRequest) RequestUrl() string
  • func (req *PutRequest) Response() *http_client.Response
• type RequestCallbackFunc
• type ResponseErrorFunc
• type ResponseSuccessFunc

Functions

func DefaultFormBodyFunc

func DefaultFormBodyFunc(c *api.Context, _ []BuilderRequest, _ map[string]any) (any, error)

func DefaultFormHeadersFunc

func DefaultFormHeadersFunc(c *api.Context, _ []BuilderRequest, _ map[string]any) (map[string]string, error)

func DefaultFormPathParamsFunc

func DefaultFormPathParamsFunc(c *api.Context, _ []BuilderRequest, _ map[string]any) (map[string]string, error)

func DefaultFormQueryParamsFunc

func DefaultFormQueryParamsFunc(c *api.Context, _ []BuilderRequest, _ map[string]any) (map[string]string, error)

func DestroyGateway

func DestroyGateway(gw *Gateway)

Types

type Builder

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

func (*Builder) Build

func (builder *Builder) Build(middlewares ...api.Handler)

func (*Builder) Delete

func (builder *Builder) Delete(request *DeleteRequest, requestCallbackFunc RequestCallbackFunc) *Builder

func (*Builder) Get

func (builder *Builder) Get(request *GetRequest, requestCallbackFunc RequestCallbackFunc) *Builder

func (*Builder) GlobalRequestCallbackFunc

func (builder *Builder) GlobalRequestCallbackFunc(globalRequestCallbackFunc GlobalRequestCallbackFunc) *Builder

func (*Builder) Post

func (builder *Builder) Post(request *PostRequest, requestCallbackFunc RequestCallbackFunc) *Builder

func (*Builder) PostStruct

func (builder *Builder) PostStruct(request *PostRequest, requestCallbackFunc RequestCallbackFunc) *Builder

func (*Builder) Put

func (builder *Builder) Put(request *PutRequest, requestCallbackFunc RequestCallbackFunc) *Builder

func (*Builder) ResponseErrorFunc

func (builder *Builder) ResponseErrorFunc(responseErrorFunc ResponseErrorFunc) *Builder

func (*Builder) ResponseSuccessFunc

func (builder *Builder) ResponseSuccessFunc(responseSuccessFunc ResponseSuccessFunc) *Builder

func (*Builder) Url

func (builder *Builder) Url(httpMethod string, relativePath string) *Builder

type BuilderRequest

type BuilderRequest interface {
	HttpMethod() string
	RequestUrl() string
	Request(c *api.Context, request *http_client.Request, historyRequests []BuilderRequest, customResultMap map[string]any) error
	Response() *http_client.Response
}

type DeleteRequest

type DeleteRequest struct {
	Url         string
	Headers     FormHeadersFunc
	PathParams  FormPathParamsFunc
	QueryParams FormQueryParamsFunc
	// contains filtered or unexported fields
}

func (*DeleteRequest) HttpMethod

func (req *DeleteRequest) HttpMethod() string

func (*DeleteRequest) Request

func (req *DeleteRequest) Request(c *api.Context, request *http_client.Request, historyRequests []BuilderRequest, customResultMap map[string]any) error

func (*DeleteRequest) RequestUrl

func (req *DeleteRequest) RequestUrl() string

func (*DeleteRequest) Response

func (req *DeleteRequest) Response() *http_client.Response

type FormBodyFunc

type FormBodyFunc func(c *api.Context, historyRequests []BuilderRequest, customResultMap map[string]any) (any, error)

type FormHeadersFunc

type FormHeadersFunc func(c *api.Context, historyRequests []BuilderRequest, customResultMap map[string]any) (map[string]string, error)

type FormPathParamsFunc

type FormPathParamsFunc func(c *api.Context, historyRequests []BuilderRequest, customResultMap map[string]any) (map[string]string, error)

type FormQueryParamsFunc

type FormQueryParamsFunc func(c *api.Context, historyRequests []BuilderRequest, customResultMap map[string]any) (map[string]string, error)

type Gateway

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

func NewGateway

func NewGateway(api *api.Api, opts ...Option) *Gateway

func (*Gateway) NewBuilder

func (gw *Gateway) NewBuilder(routerType string, version string) *Builder

type GetRequest

type GetRequest struct {
	Url         string
	Headers     FormHeadersFunc
	PathParams  FormPathParamsFunc
	QueryParams FormQueryParamsFunc
	// contains filtered or unexported fields
}

func (*GetRequest) HttpMethod

func (req *GetRequest) HttpMethod() string

func (*GetRequest) Request

func (req *GetRequest) Request(c *api.Context, request *http_client.Request, historyRequests []BuilderRequest, customResultMap map[string]any) error

func (*GetRequest) RequestUrl

func (req *GetRequest) RequestUrl() string

func (*GetRequest) Response

func (req *GetRequest) Response() *http_client.Response

type GlobalRequestCallbackFunc

type GlobalRequestCallbackFunc func(c *api.Context, request BuilderRequest, historyRequests []BuilderRequest, resultMap map[string]any) error

type Option

type Option func(options *Options)

func WithHttpClientTimeoutSec

func WithHttpClientTimeoutSec(httpClientTimeoutSec int64) Option

type Options

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

type PostRequest

type PostRequest struct {
	Url     string
	Headers FormHeadersFunc
	Body    FormBodyFunc
	// contains filtered or unexported fields
}

func (*PostRequest) HttpMethod

func (req *PostRequest) HttpMethod() string

func (*PostRequest) Request

func (req *PostRequest) Request(c *api.Context, request *http_client.Request, historyRequests []BuilderRequest, customResultMap map[string]any) error

func (*PostRequest) RequestUrl

func (req *PostRequest) RequestUrl() string

func (*PostRequest) Response

func (req *PostRequest) Response() *http_client.Response

type PutRequest

type PutRequest struct {
	Url     string
	Headers FormHeadersFunc
	Body    FormBodyFunc
	// contains filtered or unexported fields
}

func (*PutRequest) HttpMethod

func (req *PutRequest) HttpMethod() string

func (*PutRequest) Request

func (req *PutRequest) Request(c *api.Context, request *http_client.Request, historyRequests []BuilderRequest, customResultMap map[string]any) error

func (*PutRequest) RequestUrl

func (req *PutRequest) RequestUrl() string

func (*PutRequest) Response

func (req *PutRequest) Response() *http_client.Response

type RequestCallbackFunc

type RequestCallbackFunc func(c *api.Context, response *http_client.Response, resultMap map[string]any) error

type ResponseErrorFunc

type ResponseErrorFunc func(c *api.Context, err error)

type ResponseSuccessFunc

type ResponseSuccessFunc func(c *api.Context, historyRequests []BuilderRequest, resultMap map[string]any)