api

package

v0.3.4 Latest Latest Go to latest Published: Nov 25, 2022 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cygy/ginamite

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func AddResponseHandlers(handlers ...ResponseHandlerFunc)
func Initialize(host, version string, port int, timeout, retryCount int, debug bool)
type Cache
- func NewCache() (c *Cache)
- func (c *Cache) Get(key, locale string) (CachedValue, bool)
- func (c *Cache) Save(key, locale string, value interface{}, result Result, ok bool)
type CachedValue
type Client
- func NewClient(host, APIVersion string, port, timeout, retryCount int, debug bool) (client *Client)
- func (client *Client) AddResponseHandlers(handlers ...ResponseHandlerFunc)
- func (client *Client) Call(c *gin.Context, req Request) (Result, bool)
type Request
- func NewRequest() (request Request)
type ResponseHandlerFunc
type Result
type Status

Constants ¶

View Source

const (
	// GET http method
	GET = "GET"

	// POST http method
	POST = "POST"

	// PUT http method
	PUT = "PUT"

	// PATCH http method
	PATCH = "PATCH"

	// DELETE http method
	DELETE = "DELETE"

	// HEAD http method
	HEAD = "HEAD"

	// OPTIONS http method
	OPTIONS = "OPTIONS"
)

Variables ¶

This section is empty.

Functions ¶

func AddResponseHandlers ¶

func AddResponseHandlers(handlers ...ResponseHandlerFunc)

AddResponseHandlers : adds some response handlers to the current response handlers.

func Initialize ¶

func Initialize(host, version string, port int, timeout, retryCount int, debug bool)

Initialize : initializes the client to the internal API.

Types ¶

type Cache ¶

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

Cache : cached results of some API calls.

func NewCache ¶

func NewCache() (c *Cache)

NewCache : returns a new 'Cache' struct.

func (*Cache) Get ¶

func (c *Cache) Get(key, locale string) (CachedValue, bool)

Get : gets a cached value.

func (*Cache) Save ¶

func (c *Cache) Save(key, locale string, value interface{}, result Result, ok bool)

Save : saves the value to the cache.

type CachedValue ¶

type CachedValue struct {
	Value  interface{}
	Result Result
	Ok     bool
}

CachedValue : cached result of a API call.

type Client ¶

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

Client : client of an API.

var (
	// Main : main API client of the application.
	Main *Client

	// MainCache : main cache for the results of some API calls.
	MainCache = NewCache()
)

func NewClient ¶

func NewClient(host, APIVersion string, port, timeout, retryCount int, debug bool) (client *Client)

NewClient : returns a new API client struct.

func (*Client) AddResponseHandlers ¶

func (client *Client) AddResponseHandlers(handlers ...ResponseHandlerFunc)

AddResponseHandlers : adds some response handlers to the current response handlers.

func (*Client) Call ¶

func (client *Client) Call(c *gin.Context, req Request) (Result, bool)

Call : direct call to the API.

type Request ¶

type Request struct {
	Method                     string
	Endpoint                   string
	ContentType                string
	Authenticated              bool
	Body                       interface{}
	Response                   interface{}
	UseDefaultResponseHandlers bool
	ResponseHandlers           []ResponseHandlerFunc
}

Request : request of an API call.

func NewRequest ¶

func NewRequest() (request Request)

NewRequest : returns a Request struct.

type ResponseHandlerFunc ¶

type ResponseHandlerFunc func(c *gin.Context, statusCode int, requestError error, APIError response.Error) bool

ResponseHandlerFunc : handler for the API responses.

type Result ¶

type Result struct {
	StatusCode   int
	RequestError error
	APIError     response.Error
	Handled      bool
}

Result : result of an API call.

type Status ¶

type Status struct {
	Status string `json:"status"`
}

Status : result of an API call.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL