http

Documentation

Index

• func BuildRequestId(opts ...utils.Option) gin.HandlerFunc
• func Codec(req *http.Request, name string) (encoding.Codec, bool)
• func ErrorEncoder(req *http.Request, rsp http.ResponseWriter, err error)
• func GetRequestId(ctx *gin.Context) string
• func HandleMiddlewares(mw ...middleware.Middleware) gin.HandlerFunc
• func RequestBodyDecoder(req *http.Request, v interface{}) error
• func RequestQueryDecoder(req *http.Request, v interface{}) error
• func RequestVarsDecoder(req *http.Request, v interface{}) error
• func ResponseEncoder(req *http.Request, rsp http.ResponseWriter, v interface{}) error
• func Result(out proto.Message, err error) gin.HandlerFunc
• func SetContentType(subtype string) string
• func SubContentType(name string) string
• type Client
  • func NewClient(opts ...ClientOption) *Client
  • func (c *Client) DoHTTPReq(ctx context.Context, req *Request, v interface{}) error
• type ClientOption
  • func Timeout(tm time.Duration) ClientOption
  • func Transport(tr *http.Transport) ClientOption
• type Codecs
• type Context
  • func (c *Context) BindBody(v interface{}) error
  • func (c *Context) BindQuery(v interface{}) error
  • func (c *Context) BindVars(v interface{}) error
  • func (c *Context) Result(code int, v interface{}) error
  • func (c *Context) Set(req *http.Request, rsp http.ResponseWriter)
• type Decoder
• type Encoder
• type EngineParam
• type ErrDecoder
• type HandlerFunc
• type Header
• type Request
  • func NewRequest() *Request
  • func (r *Request) Decoder(dec Decoder) *Request
  • func (r *Request) Encoder(enc Encoder) *Request
  • func (r *Request) ErrDecoder(errDec ErrDecoder) *Request
  • func (r *Request) Header(header map[string]string) *Request
  • func (r *Request) Method(method string) *Request
  • func (r *Request) Param(param interface{}) *Request
  • func (r *Request) URL(url string) *Request
• type Response
  • func (r Response) Render(w http.ResponseWriter) (err error)
  • func (r Response) WriteContentType(w http.ResponseWriter)
• type Router
  • func NewRouter(srv *Server) *Router
  • func (r *Router) Handle(method, path string, hf HandlerFunc)
• type Server
  • func NewServer(opts ...ServerOption) *Server
  • func (s *Server) Route() *Router
  • func (s *Server) Start() error
  • func (s *Server) Stop(ctx context.Context) error
• type ServerOption
  • func Address(addr string) ServerOption
  • func Engine(param *EngineParam) ServerOption
  • func Handler(handler http.Handler) ServerOption
  • func Handlers(handlers ...middleware.HTTPMiddleware) ServerOption
  • func Network(network string) ServerOption

Functions

func BuildRequestId

func BuildRequestId(opts ...utils.Option) gin.HandlerFunc

func Codec

func Codec(req *http.Request, name string) (encoding.Codec, bool)

func ErrorEncoder

func ErrorEncoder(req *http.Request, rsp http.ResponseWriter, err error)

func GetRequestId

func GetRequestId(ctx *gin.Context) string

func HandleMiddlewares

func HandleMiddlewares(mw ...middleware.Middleware) gin.HandlerFunc

func RequestBodyDecoder

func RequestBodyDecoder(req *http.Request, v interface{}) error

func RequestQueryDecoder

func RequestQueryDecoder(req *http.Request, v interface{}) error

func RequestVarsDecoder

func RequestVarsDecoder(req *http.Request, v interface{}) error

func ResponseEncoder

func ResponseEncoder(req *http.Request, rsp http.ResponseWriter, v interface{}) error

func Result

func Result(out proto.Message, err error) gin.HandlerFunc

func SetContentType

func SetContentType(subtype string) string

func SubContentType

func SubContentType(name string) string

Types

type Client

type Client struct {
	*http.Client
	// contains filtered or unexported fields
}

func NewClient

func NewClient(opts ...ClientOption) *Client

func (*Client) DoHTTPReq

func (c *Client) DoHTTPReq(ctx context.Context, req *Request, v interface{}) error

type ClientOption

type ClientOption func(client *Client)

func Timeout

func Timeout(tm time.Duration) ClientOption

func Transport

func Transport(tr *http.Transport) ClientOption

type Codecs

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

type Context

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

func (*Context) BindBody

func (c *Context) BindBody(v interface{}) error

func (*Context) BindQuery

func (c *Context) BindQuery(v interface{}) error

func (*Context) BindVars

func (c *Context) BindVars(v interface{}) error

func (*Context) Result

func (c *Context) Result(code int, v interface{}) error

func (*Context) Set

func (c *Context) Set(req *http.Request, rsp http.ResponseWriter)

type Decoder

type Decoder func(ctx context.Context, rsp *http.Response, v interface{}) error

type Encoder

type Encoder func(ctx context.Context, typ string, v interface{}) ([]byte, error)

type EngineParam

type EngineParam struct {
	Mode        string
	BaseUrl     string
	Routers     []func(r gin.IRouter)
	HandlerFunc []gin.HandlerFunc
	http.FileSystem
	logger.Logger
}

type ErrDecoder

type ErrDecoder func(ctx context.Context, response *http.Response) error

type HandlerFunc

type HandlerFunc func(ctx *Context) error

type Header

type Header struct {
	Code    int         `json:"code"`
	TraceID interface{} `json:"trace_id"`
	Msg     string      `json:"msg"`
}

type Request

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

func NewRequest

func NewRequest() *Request

func (*Request) Decoder

func (r *Request) Decoder(dec Decoder) *Request

func (*Request) Encoder

func (r *Request) Encoder(enc Encoder) *Request

func (*Request) ErrDecoder

func (r *Request) ErrDecoder(errDec ErrDecoder) *Request

func (*Request) Header

func (r *Request) Header(header map[string]string) *Request

func (*Request) Method

func (r *Request) Method(method string) *Request

func (*Request) Param

func (r *Request) Param(param interface{}) *Request

func (*Request) URL

func (r *Request) URL(url string) *Request

type Response

type Response struct {
	*Header
	proto.Message `json:"data"`
}

func (Response) Render

func (r Response) Render(w http.ResponseWriter) (err error)

func (Response) WriteContentType

func (r Response) WriteContentType(w http.ResponseWriter)

type Router

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

func NewRouter

func NewRouter(srv *Server) *Router

func (*Router) Handle

func (r *Router) Handle(method, path string, hf HandlerFunc)

type Server

type Server struct {
	*http.Server

	Engine *gin.Engine
	Codecs *Codecs
	// contains filtered or unexported fields
}

func NewServer

func NewServer(opts ...ServerOption) *Server

func (*Server) Route

func (s *Server) Route() *Router

func (*Server) Start

func (s *Server) Start() error

func (*Server) Stop

func (s *Server) Stop(ctx context.Context) error

type ServerOption

type ServerOption func(server *Server)

func Address

func Address(addr string) ServerOption

func Engine

func Engine(param *EngineParam) ServerOption

func Handler

func Handler(handler http.Handler) ServerOption

func Handlers

func Handlers(handlers ...middleware.HTTPMiddleware) ServerOption

func Network

func Network(network string) ServerOption