base

Documentation

Index

• Constants
• Variables
• type APIController
  • func (c *APIController) AbortBadRequest(msg string)
  • func (c *APIController) AbortForbidden(msg string)
  • func (c *APIController) AbortInternalServerError(msg string)
  • func (c *APIController) AbortUnauthorized(msg string)
  • func (c *APIController) CheckPermission(perType string, perAction string)
  • func (c *APIController) HandleError(err error)
  • func (c *APIController) Prepare()
  • func (c *APIController) Success(data interface{})
• type APIKeyController
  • func (c *APIKeyController) AddError(err string)
  • func (c *APIKeyController) AddErrorAndResponse(err string, code int)
  • func (c *APIKeyController) HandleByCode(code int)
  • func (c *APIKeyController) HandleResponse(data interface{})
  • func (c *APIKeyController) Prepare()
• type ErrorSubCode
• type LoggedInController
  • func (c *LoggedInController) Prepare()
• type ParamBuilderController
  • func (c *ParamBuilderController) BuildQueryParam() *common.QueryParam
  • func (c *ParamBuilderController) GetBoolParamFromQuery(param string) bool
  • func (c *ParamBuilderController) GetBoolParamFromQueryWithDefault(param string, defaultValue bool) bool
  • func (c *ParamBuilderController) GetDeleteFromQuery() bool
  • func (c *ParamBuilderController) GetIDFromURL() int64
  • func (c *ParamBuilderController) GetIntParamFromQuery(param string) int64
  • func (c *ParamBuilderController) GetIntParamFromURL(param string) int64
  • func (c *ParamBuilderController) GetIsOnlineFromQuery() bool
  • func (c *ParamBuilderController) GetLogicalFromQuery() bool
• type Result
• type ResultHandlerController
  • func (c *ResultHandlerController) AbortBadRequest(msg string)
  • func (c *ResultHandlerController) AbortBadRequestFormat(paramName string)
  • func (c *ResultHandlerController) AbortForbidden(msg string)
  • func (c *ResultHandlerController) AbortInternalServerError(msg string)
  • func (c *ResultHandlerController) AbortUnauthorized(msg string)
  • func (c *ResultHandlerController) HandleError(err error) int
  • func (c *ResultHandlerController) Success(data interface{})

Constants

const (
	ErrorSubCodeInsufficientResource = 403001
)

Variables

var (
	PublishRequestMessageMethodFilter = []string{
		"POST",
		"PUT",
		"DELETE",
		"PATCH",
	}
)

Types

type APIController

type APIController struct {
	LoggedInController

	NamespaceId int64
	AppId       int64
}

func (*APIController) AbortBadRequest

func (c *APIController) AbortBadRequest(msg string)

func (*APIController) AbortForbidden

func (c *APIController) AbortForbidden(msg string)

Abort stops controller handler and show the error data， e.g. Prepare

func (*APIController) AbortInternalServerError

func (c *APIController) AbortInternalServerError(msg string)

func (*APIController) AbortUnauthorized

func (c *APIController) AbortUnauthorized(msg string)

func (*APIController) CheckPermission

func (c *APIController) CheckPermission(perType string, perAction string)

* 检查资源权限

func (*APIController) HandleError

func (c *APIController) HandleError(err error)

Handle return http code and body normally, need return

func (*APIController) Prepare

func (c *APIController) Prepare()

func (*APIController) Success

func (c *APIController) Success(data interface{})

type APIKeyController

type APIKeyController struct {
	beego.Controller

	APIKey  *models.APIKey
	Action  string
	Success response.Success
	Failure response.Failure
}

func (*APIKeyController) AddError

func (c *APIKeyController) AddError(err string)

func (*APIKeyController) AddErrorAndResponse

func (c *APIKeyController) AddErrorAndResponse(err string, code int)

func (*APIKeyController) HandleByCode

func (c *APIKeyController) HandleByCode(code int)

func (*APIKeyController) HandleResponse

func (c *APIKeyController) HandleResponse(data interface{})

用于负责 get 数据的接口，当 error 列表不为空的时候，返回 error 列表 当 参数为 nil 的时候，返回 "200"

func (*APIKeyController) Prepare

func (c *APIKeyController) Prepare()

*

• 通过 apikey 参数判断调用权限
• apikey 类型：全局apikey（管理员可用）、命名空间级别的 apikey 和项目级别的 apikey（app 内部可用） *

type ErrorSubCode

type ErrorSubCode int

type LoggedInController

type LoggedInController struct {
	ParamBuilderController

	User *models.User
}

func (*LoggedInController) Prepare

func (c *LoggedInController) Prepare()

type ParamBuilderController

type ParamBuilderController struct {
	ResultHandlerController
}

func (*ParamBuilderController) BuildQueryParam

func (c *ParamBuilderController) BuildQueryParam() *common.QueryParam

TODO: 需要重构成独立的Controller，参考Django的generic views设计

func (*ParamBuilderController) GetBoolParamFromQuery

func (c *ParamBuilderController) GetBoolParamFromQuery(param string) bool

func (*ParamBuilderController) GetBoolParamFromQueryWithDefault

func (c *ParamBuilderController) GetBoolParamFromQueryWithDefault(param string, defaultValue bool) bool

func (*ParamBuilderController) GetDeleteFromQuery

func (c *ParamBuilderController) GetDeleteFromQuery() bool

func (*ParamBuilderController) GetIDFromURL

func (c *ParamBuilderController) GetIDFromURL() int64

func (*ParamBuilderController) GetIntParamFromQuery

func (c *ParamBuilderController) GetIntParamFromQuery(param string) int64

func (*ParamBuilderController) GetIntParamFromURL

func (c *ParamBuilderController) GetIntParamFromURL(param string) int64

func (*ParamBuilderController) GetIsOnlineFromQuery

func (c *ParamBuilderController) GetIsOnlineFromQuery() bool

func (*ParamBuilderController) GetLogicalFromQuery

func (c *ParamBuilderController) GetLogicalFromQuery() bool

type Result

type Result struct {
	Data interface{} `json:"data"`
}

type ResultHandlerController

type ResultHandlerController struct {
	beego.Controller
}

func (*ResultHandlerController) AbortBadRequest

func (c *ResultHandlerController) AbortBadRequest(msg string)

func (*ResultHandlerController) AbortBadRequestFormat

func (c *ResultHandlerController) AbortBadRequestFormat(paramName string)

format BadRequest with param name.

func (*ResultHandlerController) AbortForbidden

func (c *ResultHandlerController) AbortForbidden(msg string)

Abort stops controller handler and show the error data， e.g. Prepare

func (*ResultHandlerController) AbortInternalServerError

func (c *ResultHandlerController) AbortInternalServerError(msg string)

func (*ResultHandlerController) AbortUnauthorized

func (c *ResultHandlerController) AbortUnauthorized(msg string)

func (*ResultHandlerController) HandleError

func (c *ResultHandlerController) HandleError(err error) int

Handle return http code and body normally, need return

func (*ResultHandlerController) Success

func (c *ResultHandlerController) Success(data interface{})