api

Documentation

Index

• Variables
• func DataWithErr(ctx *gin.Context, err error, data interface{}, fns ...ResponseFn)
• func Error(ctx *gin.Context, fns ...ResponseFn)
• func ParameterError(ctx *gin.Context, fns ...ResponseFn)
• func Router[T any](routerName string, data CommonService[T], api *gin.RouterGroup, ...) (router *gin.RouterGroup)
• func Success(ctx *gin.Context, fns ...ResponseFn)
• func WeChatPayError(ctx *gin.Context)
• func WeChatPaySuccess(ctx *gin.Context)
• type Common
  • func (c *Common[T]) Add() gin.HandlerFunc
  • func (c *Common[T]) Content() gin.HandlerFunc
  • func (c *Common[T]) Delete() gin.HandlerFunc
  • func (c *Common[T]) List() gin.HandlerFunc
  • func (c *Common[T]) ListPage() gin.HandlerFunc
  • func (c *Common[T]) Status() gin.HandlerFunc
  • func (c *Common[T]) Update() gin.HandlerFunc
  • func (c *Common[T]) UpdateFiled() gin.HandlerFunc
• type CommonApi
  • func NewCommon[T any](common CommonService[T]) CommonApi
• type CommonService
• type Response
• type ResponseFn
  • func Code(code int) ResponseFn
  • func Data(data interface{}) ResponseFn
  • func Err(err error) ResponseFn
  • func Msg(msg string) ResponseFn
• type RouterConst
• type RouterFn

Variables

var (
	SuccessCode    = 200
	ErrorCode      = 100
	ErrorParameter = 422
	SuccessMsg     = "success"
	ErrorMsg       = "error"
	ParameterMsg   = "参数错误"
)

Functions

func DataWithErr

func DataWithErr(ctx *gin.Context, err error, data interface{}, fns ...ResponseFn)

func Error

func Error(ctx *gin.Context, fns ...ResponseFn)

Error /*

func ParameterError

func ParameterError(ctx *gin.Context, fns ...ResponseFn)

ParameterError /*

func Router

func Router[T any](routerName string, data CommonService[T], api *gin.RouterGroup, uris ...RouterConst) (router *gin.RouterGroup)

func Success

func Success(ctx *gin.Context, fns ...ResponseFn)

Success /*

func WeChatPayError

func WeChatPayError(ctx *gin.Context)

WeChatPayError /*

func WeChatPaySuccess

func WeChatPaySuccess(ctx *gin.Context)

Types

type Common

type Common[T any] struct {
	// contains filtered or unexported fields
}

func (*Common[T]) Add

func (c *Common[T]) Add() gin.HandlerFunc

func (*Common[T]) Content

func (c *Common[T]) Content() gin.HandlerFunc

func (*Common[T]) Delete

func (c *Common[T]) Delete() gin.HandlerFunc

func (*Common[T]) List

func (c *Common[T]) List() gin.HandlerFunc

func (*Common[T]) ListPage

func (c *Common[T]) ListPage() gin.HandlerFunc

func (*Common[T]) Status

func (c *Common[T]) Status() gin.HandlerFunc

func (*Common[T]) Update

func (c *Common[T]) Update() gin.HandlerFunc

func (*Common[T]) UpdateFiled

func (c *Common[T]) UpdateFiled() gin.HandlerFunc

type CommonApi

type CommonApi interface {
	Content() gin.HandlerFunc
	Status() gin.HandlerFunc
	UpdateFiled() gin.HandlerFunc
	Add() gin.HandlerFunc
	Update() gin.HandlerFunc
	Delete() gin.HandlerFunc
	List() gin.HandlerFunc
	ListPage() gin.HandlerFunc
}

func NewCommon

func NewCommon[T any](common CommonService[T]) CommonApi

type CommonService

type CommonService[T any] interface {
	Add(ctx *gin.Context) (err error)
	Update(ctx *gin.Context) (err error)
	Delete(ctx *gin.Context) (err error)
	List(ctx *gin.Context) (items []*T, err error)
	ListPage(ctx *gin.Context) (list []*T, count int64, err error)
	UpdateFiled(ctx *gin.Context) (err error)
	Content(ctx *gin.Context) (content *T, err error)
	Status(ctx *gin.Context) (err error)
}

type Response

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

type ResponseFn

type ResponseFn func(response *Response) *Response

func Code

func Code(code int) ResponseFn

Code /*

func Data

func Data(data interface{}) ResponseFn

Data /*

func Err

func Err(err error) ResponseFn

Err /*

func Msg

func Msg(msg string) ResponseFn

Msg /*

type RouterConst

type RouterConst string

const Add RouterConst = "add"

const Content RouterConst = "content"

const Delete RouterConst = "delete"

const List RouterConst = "list"

const ListPage RouterConst = "listPage"

const Status RouterConst = "status"

const Update RouterConst = "update"

const UpdateFiled RouterConst = "updateFiled"

type RouterFn

type RouterFn func(router *gin.RouterGroup)