rest

package module

v0.1.2 Latest Latest Go to latest Published: Jun 30, 2020 License: BSD-3-Clause Imports: 13 Imported by: 5

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/KarpelesLab/rest

Links

Open Source Insights

README ¶

rest API

Allows accessing functions from the rest api.

Documentation ¶

Index ¶

Variables
func Apply(ctx context.Context, req, method string, param RestParam, target interface{}) error
func RedirectError(u *url.URL) error
func RedirectErrorCode(u *url.URL, code int) error
func SendRedirect(w http.ResponseWriter, url string, code int)
type RestParam
type RestResponse
- func Do(ctx context.Context, req, method string, param RestParam) (*RestResponse, error)
- func (r *RestResponse) ReadValue(ctx context.Context) (interface{}, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var Debug = false

View Source

var RestHttpClient = &http.Client{
	Transport: &http.Transport{
		Proxy:                 http.ProxyFromEnvironment,
		MaxIdleConns:          100,
		IdleConnTimeout:       90 * time.Second,
		TLSHandshakeTimeout:   10 * time.Second,
		ExpectContinueTimeout: 1 * time.Second,
	},
	Timeout: 120 * time.Second,
}

View Source

var (
	SystemProxy = &httputil.ReverseProxy{
		Director:  systemProxyDirector,
		Transport: RestHttpClient.Transport,
	}
)

Functions ¶

func Apply ¶

func Apply(ctx context.Context, req, method string, param RestParam, target interface{}) error

func RedirectError ¶

func RedirectError(u *url.URL) error

func RedirectErrorCode ¶

func RedirectErrorCode(u *url.URL, code int) error

code can be one of http.StatusMovedPermanently or http.StatusFound or any 3xx http status code

func SendRedirect ¶

func SendRedirect(w http.ResponseWriter, url string, code int)

Types ¶

type RestParam ¶

type RestParam map[string]interface{}

type RestResponse ¶

type RestResponse struct {
	Result string          `json:"result"` // "success" or "error" (or "redirect")
	Data   json.RawMessage `json:"data"`
	Error  string          `json:"error"`

	Paging interface{} `json:"paging"`
	Job    interface{} `json:"job"`
	Time   interface{} `json:"time"`
	Access interface{} `json:"access"`

	RedirectUrl  string `json:"redirect_url"`
	RedirectCode int    `json:"redirect_code"`
}

func Do ¶

func Do(ctx context.Context, req, method string, param RestParam) (*RestResponse, error)

func (*RestResponse) ReadValue ¶

func (r *RestResponse) ReadValue(ctx context.Context) (interface{}, error)

Source Files ¶

View all Source files

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