api

Documentation

Index

• type Api
  • func NewApi() *Api
  • func (this *Api) GetDescription() string
  • func (this *Api) GetParamType() string
  • func (this *Api) GetParams() interface{}
  • func (this *Api) WrapJson(method api_session.ApiMethod, func_ ApiHandlerType) func(response http.ResponseWriter, request *http.Request)
• type ApiHandlerType
• type ApiResult
  • func DefaultReturnDataFunc(msg string, internalMsg string, code uint64, data interface{}) *ApiResult
• type ReturnHookFuncType

Types

type Api

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

func NewApi

func NewApi() *Api

func (*Api) GetDescription

func (this *Api) GetDescription() string

func (*Api) GetParamType

func (this *Api) GetParamType() string

func (*Api) GetParams

func (this *Api) GetParams() interface{}

func (*Api) WrapJson

func (this *Api) WrapJson(method api_session.ApiMethod, func_ ApiHandlerType) func(response http.ResponseWriter, request *http.Request)

* wrap api处理器

type ApiHandlerType

type ApiHandlerType func(apiSession *api_session.ApiSessionClass) interface{}

type ApiResult

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

func DefaultReturnDataFunc

func DefaultReturnDataFunc(msg string, internalMsg string, code uint64, data interface{}) *ApiResult

type ReturnHookFuncType

type ReturnHookFuncType func(apiContext *api_session.ApiSessionClass, apiResult *ApiResult) (interface{}, *go_error.ErrorInfo)