api

Documentation

Index

• func OutputJson(w http.ResponseWriter, statusCode int, data interface{})
• type API
• type APIConf
  • func NewApiConf(port string, cors bool, ignoreMids []string, ignoreApis []string) *APIConf
  • func (ac *APIConf) EnableCORS() bool
  • func (ac *APIConf) GetPort() string
  • func (ac *APIConf) InitAPI(r *mux.Router, middles []mid.Middle, authMiddle mid.AuthMidInter, apis ...API)
• type APIHandler
• type ApiDI
• type ErrorOutputAPI
  • func NewErrorOutputAPI(service string) ErrorOutputAPI
• type GinAPI
• type GinApiHandler
• type GinApiServer
  • func NewGinApiServer(mode string) GinApiServer

Functions

func OutputJson

func OutputJson(w http.ResponseWriter, statusCode int, data interface{})

Types

type API

type API interface {
	GetAPIs() []*APIHandler
	GetName() string
}

type APIConf

type APIConf struct {
	Port   string          `yaml:"port,omitempty"`
	Cors   bool            `yaml:"cors"`
	Middle map[string]bool `yaml:"middle,omitempty"`
	Apis   map[string]bool `yaml:"api,omitempty"`
}

func NewApiConf

func NewApiConf(port string, cors bool, ignoreMids []string, ignoreApis []string) *APIConf

func (*APIConf) EnableCORS

func (ac *APIConf) EnableCORS() bool

func (*APIConf) GetPort

func (ac *APIConf) GetPort() string

func (*APIConf) InitAPI

func (ac *APIConf) InitAPI(
	r *mux.Router,
	middles []mid.Middle,
	authMiddle mid.AuthMidInter,
	apis ...API,
)

type APIHandler

type APIHandler struct {
	Path   string
	Next   func(http.ResponseWriter, *http.Request)
	Method string
	Auth   bool
	Group  []auth.UserPerm
}

type ApiDI

type ApiDI interface {
	InitAPI(
		r *mux.Router,
		middles []mid.Middle,
		authMiddle mid.AuthMidInter,
		apis ...API,
	)
	GetPort() string
	EnableCORS() bool
}

type ErrorOutputAPI

type ErrorOutputAPI interface {
	GinOutputErr(c *gin.Context, err error)
}

func NewErrorOutputAPI

func NewErrorOutputAPI(service string) ErrorOutputAPI

type GinAPI

type GinAPI interface {
	GetAPIs() []*GinApiHandler
	GetName() string
}

type GinApiHandler

type GinApiHandler struct {
	Method  string
	Path    string
	Handler func(c *gin.Context)
	Auth    bool
	Group   []auth.UserPerm
}

type GinApiServer

type GinApiServer interface {
	AddAPIs(handlers ...GinAPI) GinApiServer
	Middles(mids ...mid.GinMiddle) GinApiServer
	SetAuth(authmid mid.AuthGinMidInter) GinApiServer
	Run(port string) error
}

func NewGinApiServer

func NewGinApiServer(mode string) GinApiServer