nctrl

package

v0.1.1 Latest Latest Go to latest Published: Oct 13, 2022 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitee.com/natas-public/beego-utils

Links

Open Source Insights

Documentation ¶

Overview ¶

Package nctrl ******************************************************************************

@DESC Controller相关的通用处理方法
@AUTH Neo
@DATE 2022-03-14
@CHANGE LOGS
DATE CHANGER DETAIL *****************************************************************************

Index ¶

Constants
func GetParam(ctx *context.Context, key string) string
func GetParamInt(ctx *context.Context, key string) int32
func ParseReqData(ctx *context.Context, v any) any
func SetJSONRes(ctx *context.Context, data any)
func SetJSONResOK(ctx *context.Context)
func SetJSONResOnlyCode(ctx *context.Context, code appcode.AppCode)
func SetJSONResWhole(ctx *context.Context, res *jsonRes)
func SetJSONResWithCode(ctx *context.Context, data any, code appcode.AppCode)
func SetJSONResWithCodeMsg(ctx *context.Context, data any, code appcode.AppCode, msg string)
type WhoAmI
- func GetWho(ctx *context.Context) *WhoAmI
- func (whoAmI *WhoAmI) Parse(wai string) *WhoAmI

Constants ¶

View Source

const (
	HeaderWhoAmI = "who-am-i"
)

Variables ¶

This section is empty.

Functions ¶

func GetParam ¶

func GetParam(ctx *context.Context, key string) string

GetParam ******************************************************************************

@DESC 获取URI参数值
@PARAMS ctx *context.Context http请求信息
key string 请求方法
@RETURN
@AUTH Neo
@DATE 2022-03-14
@CHANGE LOGS
DATE CHANGER DETAIL *****************************************************************************

func GetParamInt ¶

func GetParamInt(ctx *context.Context, key string) int32

GetParamInt ******************************************************************************

@DESC 获取URI参数值
@PARAMS ctx *context.Context http请求信息
key string 请求方法
@RETURN
@AUTH Neo
@DATE 2022-03-14
@CHANGE LOGS
DATE CHANGER DETAIL *****************************************************************************

func ParseReqData ¶ added in v0.1.0

func ParseReqData(ctx *context.Context, v any) any

ParseReqData ******************************************************************************

@DESC 解析RequestBody数据
@PARAMS ctx *context.Context http请求信息
v any 解析结构
@RETURN
@AUTH Neo
@DATE 2022-03-14
@CHANGE LOGS
DATE CHANGER DETAIL *****************************************************************************

func SetJSONRes ¶

func SetJSONRes(ctx *context.Context, data any)

SetJSONRes ******************************************************************************

@DESC 设置有数据的返回JSON，正常返回
@PARAMS ctx *context.Context http请求信息
data any 返回的数据内容
@RETURN
@AUTH Neo
@DATE 2022-03-14
@CHANGE LOGS
DATE CHANGER DETAIL *****************************************************************************

func SetJSONResOK ¶

func SetJSONResOK(ctx *context.Context)

SetJSONResOK ******************************************************************************

@DESC 设置无数据的返回JSON，正常返回
@PARAMS ctx *context.Context http请求信息
@RETURN
@AUTH Neo
@DATE 2022-03-14
@CHANGE LOGS
DATE CHANGER DETAIL *****************************************************************************

func SetJSONResOnlyCode ¶

func SetJSONResOnlyCode(ctx *context.Context, code appcode.AppCode)

SetJSONResOnlyCode ******************************************************************************

@DESC 设置有数据的返回JSON，正常返回
@PARAMS ctx *context.Context http请求信息
code int 返回Code
@RETURN
@AUTH Neo
@DATE 2022-03-14
@CHANGE LOGS
DATE CHANGER DETAIL *****************************************************************************

func SetJSONResWhole ¶

func SetJSONResWhole(ctx *context.Context, res *jsonRes)

SetJSONResWhole ******************************************************************************

@DESC 设置完整的返回信息结构
@PARAMS ctx *context.Context http请求信息
res any 完整的返回消息结构
@RETURN
@AUTH Neo
@DATE 2022-03-14
@CHANGE LOGS
DATE CHANGER DETAIL *****************************************************************************

func SetJSONResWithCode ¶

func SetJSONResWithCode(ctx *context.Context, data any, code appcode.AppCode)

SetJSONResWithCode ******************************************************************************

@DESC 设置有数据的返回JSON，并设置返回Code
@PARAMS ctx *context.Context http请求信息
data any 返回的数据内容
code int 返回Code
@RETURN
@AUTH Neo
@DATE 2022-03-14
@CHANGE LOGS
DATE CHANGER DETAIL *****************************************************************************

func SetJSONResWithCodeMsg ¶

func SetJSONResWithCodeMsg(ctx *context.Context, data any, code appcode.AppCode, msg string)

SetJSONResWithCodeMsg ******************************************************************************

@DESC 设置有数据的返回JSON，并设置返回Code和返回消息
@PARAMS ctx *context.Context http请求信息
data any 返回的数据内容
code int 返回Code
msg string 返回消息
@RETURN
@AUTH Neo
@DATE 2022-03-14
@CHANGE LOGS
DATE CHANGER DETAIL *****************************************************************************

Types ¶

type WhoAmI ¶

type WhoAmI struct {
	Platform  string
	BelongsTo string
	Who       string
}

func GetWho ¶

func GetWho(ctx *context.Context) *WhoAmI

GetWho ******************************************************************************

@DESC Api请求头中获取 "Who am I" 信息
@PARAMS ctx *context.Context http请求信息
@RETURN *WhoAmI "Who am I"信息
@AUTH Neo
@DATE 2022-03-14
@CHANGE LOGS
DATE CHANGER DETAIL *****************************************************************************

func (*WhoAmI) Parse ¶

func (whoAmI *WhoAmI) Parse(wai string) *WhoAmI

Parse ******************************************************************************

@DESC 解析 "Who am I" 字符串
@PARAMS wai "Who am I"字符串
@RETURN *WhoAmI "Who am I"信息
@AUTH Neo
@DATE 2022-03-14
@CHANGE LOGS
DATE CHANGER DETAIL *****************************************************************************

Source Files ¶

View all Source files

nctrl.go

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