api

Documentation

Index

• func WrapJson(methodController map[string]*Api) func(response http.ResponseWriter, request *http.Request)
• type Api
  • func New404Api() *Api
  • func NewApi(params *NewApiParamsType) *Api
  • func (api *Api) ControllerFunc() ApiHandlerType
  • func (api *Api) Description() string
  • func (api *Api) IsIgnoreRootPath() bool
  • func (api *Api) Method() api_session.ApiMethod
  • func (api *Api) ParamType() string
  • func (api *Api) Params() interface{}
  • func (api *Api) Path() string
  • func (api *Api) Strategies() []StrategyData
• type ApiHandlerType
• type ApiResult
• type NewApiParamsType
• type ReturnHookFuncType
• type StrategyData

Functions

func WrapJson

func WrapJson(methodController map[string]*Api) func(response http.ResponseWriter, request *http.Request)

* wrap api处理器. 一个path一个，方法内分别处理method

Types

type Api

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

func New404Api

func New404Api() *Api

func NewApi

func NewApi(params *NewApiParamsType) *Api

func (*Api) ControllerFunc

func (api *Api) ControllerFunc() ApiHandlerType

func (*Api) Description

func (api *Api) Description() string

func (*Api) IsIgnoreRootPath

func (api *Api) IsIgnoreRootPath() bool

func (*Api) Method

func (api *Api) Method() api_session.ApiMethod

func (*Api) ParamType

func (api *Api) ParamType() string

func (*Api) Params

func (api *Api) Params() interface{}

func (*Api) Path

func (api *Api) Path() string

func (*Api) Strategies

func (api *Api) Strategies() []StrategyData

type ApiHandlerType

type ApiHandlerType func(apiSession _type2.IApiSession) (interface{}, *go_error.ErrorInfo)

type ApiResult

type ApiResult struct {
	Msg  string      `json:"msg"`
	Code uint64      `json:"code"`
	Data interface{} `json:"data"`
}

type NewApiParamsType

type NewApiParamsType struct {
	Description              string
	Path                     string                // api路径
	IsIgnoreRootPath         bool                  // api路径是否忽略根路径
	IsIgnoreGlobalStrategies bool                  // 是否跳过全局策略
	Method                   api_session.ApiMethod // api方法
	Strategies               []StrategyData        // api前置处理策略,不包含全局策略
	Params                   interface{}           // api参数
	ReturnValue              interface{}           // api返回值
	ControllerFunc           ApiHandlerType        // api业务处理器
	ParamType                string                // 参数类型。默认 application/json，可选 multipart/form-data，空表示都支持
	ReturnHookFunc           ReturnHookFuncType    // 返回前的处理函数
}

type ReturnHookFuncType

type ReturnHookFuncType func(apiSession _type2.IApiSession, apiResult *ApiResult) (interface{}, *go_error.ErrorInfo)

type StrategyData

type StrategyData struct {
	Strategy api_strategy.IApiStrategy
	Disable  bool
}