gf

Documentation

Index

• Constants
• func DbCTX(ctx context.Context) gdb.DB
• func Register(cnf DBConf)
• type AttrType
  • func (e AttrType) String() string
• type BReq
  • func (b *BReq) GetFile(ctx context.Context) (multipart.File, *multipart.FileHeader, error)
  • func (b *BReq) ReqCTX(ctx context.Context) *ghttp.Request
• type BSConf
• type BootStrap
  • func NewBStrap(conf BSConf) *BootStrap
  • func (boot *BootStrap) AllAttribute(r *ghttp.Request) []string
  • func (boot *BootStrap) AllowAnonymous(r *ghttp.Request) bool
  • func (boot *BootStrap) Attribute(r *ghttp.Request, a AttrType) bool
  • func (boot *BootStrap) GetServer() *ghttp.Server
  • func (boot *BootStrap) OAI() *goai.OpenApiV3
  • func (boot *BootStrap) Run()
  • func (boot *BootStrap) Use(h ...func(r *ghttp.Request)) *BootStrap
  • func (boot *BootStrap) UseController(prefix string, ctrl ...interface{}) *BootStrap
  • func (boot *BootStrap) UseCors() *BootStrap
  • func (boot *BootStrap) UseOAI(authKey, title, description, ver string) *BootStrap
  • func (boot *BootStrap) UsePublic() *BootStrap
  • func (boot *BootStrap) UseStatic() *BootStrap
  • func (boot *BootStrap) UseView() *BootStrap
• type DBConf
• type RType
• type Res

Constants

const (
	XIgnoreKey        = "x-ignore" //忽略api显示的自定义key
	XAttrKey          = "x-attr"
	StaticVirtualPath = "/static/files"
	PublicVirtualPath = "/static/public"
	ViewPath          = "/views"
)

Functions

func DbCTX

func DbCTX(ctx context.Context) gdb.DB

func Register

func Register(cnf DBConf)

Register 注册数据库上下文

Types

type AttrType

type AttrType string

const (
	AllowAnonymous AttrType = "allow-anonymous" //允许通过所有验证
)

func (AttrType) String

func (e AttrType) String() string

type BReq

type BReq struct {
}

func (*BReq) GetFile

func (b *BReq) GetFile(ctx context.Context) (multipart.File, *multipart.FileHeader, error)

GetFile 获取文件对象

func (*BReq) ReqCTX

func (b *BReq) ReqCTX(ctx context.Context) *ghttp.Request

ReqCTX 拉取上下文

type BSConf

type BSConf struct {
	Port       int
	RootPrefix string
}

type BootStrap

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

func NewBStrap

func NewBStrap(conf BSConf) *BootStrap

func (*BootStrap) AllAttribute

func (boot *BootStrap) AllAttribute(r *ghttp.Request) []string

AllAttribute 属性

func (*BootStrap) AllowAnonymous

func (boot *BootStrap) AllowAnonymous(r *ghttp.Request) bool

AllowAnonymous 允许跳过各种验证

func (*BootStrap) Attribute

func (boot *BootStrap) Attribute(r *ghttp.Request, a AttrType) bool

Attribute 属性

func (*BootStrap) GetServer

func (boot *BootStrap) GetServer() *ghttp.Server

func (*BootStrap) OAI

func (boot *BootStrap) OAI() *goai.OpenApiV3

OAI openApiV3实例

func (*BootStrap) Run

func (boot *BootStrap) Run()

Run 执行

func (*BootStrap) Use

func (boot *BootStrap) Use(h ...func(r *ghttp.Request)) *BootStrap

func (*BootStrap) UseController

func (boot *BootStrap) UseController(prefix string, ctrl ...interface{}) *BootStrap

func (*BootStrap) UseCors

func (boot *BootStrap) UseCors() *BootStrap

func (*BootStrap) UseOAI

func (boot *BootStrap) UseOAI(authKey, title, description, ver string) *BootStrap

func (*BootStrap) UsePublic

func (boot *BootStrap) UsePublic() *BootStrap

func (*BootStrap) UseStatic

func (boot *BootStrap) UseStatic() *BootStrap

func (*BootStrap) UseView

func (boot *BootStrap) UseView() *BootStrap

type DBConf

type DBConf struct {
	Host  string
	Port  string
	User  string
	Pass  string
	Name  string
	Type  string
	Debug bool
}

type RType

type RType int

const (
	API RType
	VIEW
)

type Res

type Res interface {
	Type() RType
	Write(r *ghttp.Request)
}