httplib

package

v1.5.0 Latest Latest Go to latest Published: Apr 1, 2021 License: MIT Imports: 11 Imported by: 0

Details

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

Repository

github.com/rovergulf/utils

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func ErrorResponseJSON(w http.ResponseWriter, httpCode int, internalCode int, err error)
func ExtractTokenFromRequest(r *http.Request) (string, error)
func GetAuthorizationTokenFromRequestHeader(r *http.Request, prefix string) string
func GetDeviceTypeFromRequestHeaders(r *http.Request) string
func GetLimitAndOffsetFromPageNumber(page, limit int) (int, int)
func GetLimitAndOffsetFromRequest(r *http.Request) (int, int)
func GetPagingInt32FromPageNumber(page, limit int) (int32, int32)
func GetPagingInt32FromRequest(r *http.Request) (int32, int32)
func GetPagingInt64FromPageNumber(page, limit int) (int64, int64)
func GetPagingInt64FromRequest(r *http.Request) (int64, int64)
func GetRequestAuthorFootprint(r *http.Request) string
func GetRequestCookieStringValue(r *http.Request, cookieName string) (string, error)
func GetRequestIPAddress(r *http.Request) string
func ResponseJSON(w http.ResponseWriter, v interface{})
func SetCookieName(name string)
func SetHttpCookieValue(w http.ResponseWriter, domain, cookieName, value string, expireTime time.Time)
func SuccessfulResultMap() map[string]interface{}
type ApiError
- func NewApiError(code int, msg string) *ApiError
- func (e ApiError) Error() string
- func (e ApiError) String() string
type CreatedObjectId
type Interceptor
- func NewInterceptor(lg *zap.SugaredLogger, j *tracing.Jaeger) Interceptor
- func (i *Interceptor) ServeHTTP(w http.ResponseWriter, r *http.Request)
type ListResult
type Response
- func SuccessfulResult() Response

Constants ¶

View Source

const (
	PrefixBearer = "Bearer "
)

Variables ¶

View Source

var CookieName = "session"

Functions ¶

func ErrorResponseJSON ¶

func ErrorResponseJSON(w http.ResponseWriter, httpCode int, internalCode int, err error)

Sends error http response

func ExtractTokenFromRequest ¶ added in v0.4.0

func ExtractTokenFromRequest(r *http.Request) (string, error)

func GetAuthorizationTokenFromRequestHeader ¶

func GetAuthorizationTokenFromRequestHeader(r *http.Request, prefix string) string

func GetDeviceTypeFromRequestHeaders ¶

func GetDeviceTypeFromRequestHeaders(r *http.Request) string

GetDeviceTypeFromRequestHeaders

func GetLimitAndOffsetFromPageNumber ¶

func GetLimitAndOffsetFromPageNumber(page, limit int) (int, int)

func GetLimitAndOffsetFromRequest ¶

func GetLimitAndOffsetFromRequest(r *http.Request) (int, int)

func GetPagingInt32FromPageNumber ¶

func GetPagingInt32FromPageNumber(page, limit int) (int32, int32)

func GetPagingInt32FromRequest ¶

func GetPagingInt32FromRequest(r *http.Request) (int32, int32)

func GetPagingInt64FromPageNumber ¶

func GetPagingInt64FromPageNumber(page, limit int) (int64, int64)

func GetPagingInt64FromRequest ¶

func GetPagingInt64FromRequest(r *http.Request) (int64, int64)

func GetRequestAuthorFootprint ¶

func GetRequestAuthorFootprint(r *http.Request) string

func GetRequestCookieStringValue ¶

func GetRequestCookieStringValue(r *http.Request, cookieName string) (string, error)

GetRequestCookieStringValue

func GetRequestIPAddress ¶

func GetRequestIPAddress(r *http.Request) string

func ResponseJSON ¶

func ResponseJSON(w http.ResponseWriter, v interface{})

Sends OK JSON response

func SetCookieName ¶ added in v0.4.0

func SetCookieName(name string)

func SetHttpCookieValue ¶

func SetHttpCookieValue(w http.ResponseWriter, domain, cookieName, value string, expireTime time.Time)

SetHttpCookieValue

func SuccessfulResultMap ¶

func SuccessfulResultMap() map[string]interface{}

Types ¶

type ApiError ¶

type ApiError struct {
	HttpStatus int         `json:"http_status,omitempty"`
	ErrorCode  int         `json:"code"`
	Message    interface{} `json:"message"`
	Timestamp  interface{} `json:"timestamp"`
}

func NewApiError ¶

func NewApiError(code int, msg string) *ApiError

func (ApiError) Error ¶

func (e ApiError) Error() string

func (ApiError) String ¶

func (e ApiError) String() string

type CreatedObjectId ¶

type CreatedObjectId struct {
	Id   interface{} `json:"id,omitempty" yaml:"id,omitempty"`
	UUID interface{} `json:"uuid,omitempty" yaml:"uuid,omitempty"`
}

type Interceptor ¶ added in v1.3.1

type Interceptor struct {
	Router *mux.Router
	Tracer opentracing.Tracer
	Logger *zap.SugaredLogger
}

Interceptor

func NewInterceptor ¶ added in v1.3.1

func NewInterceptor(lg *zap.SugaredLogger, j *tracing.Jaeger) Interceptor

func (*Interceptor) ServeHTTP ¶ added in v1.3.1

func (i *Interceptor) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP

type ListResult ¶

type ListResult struct {
	Results interface{} `json:"results,omitempty" yaml:"results,omitempty"`
	Count   int32       `json:"count" yaml:"count"`
	HasPrev bool        `json:"has_prev" yaml:"has_prev"`
	HasNext bool        `json:"has_next" yaml:"has_next"`
}

type Response ¶ added in v0.1.3

type Response struct {
	Success   bool        `json:"success" yaml:"success"`
	Timestamp interface{} `json:"timestamp,omitempty" yaml:"timestamp,omitempty" `
	Message   interface{} `json:"message,omitempty" yaml:"message,omitempty"`
	Data      interface{} `json:"data,omitempty" yaml:"data,omitempty"`
	CreatedObjectId
	RequestStatus *ApiError `json:"request_status" yaml:"request_status,omitempty"`
}

func SuccessfulResult ¶

func SuccessfulResult() Response

Source Files ¶

View all Source files

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