api

README

quick start

1.eg.helloword

api.GET(func() interface{} {
      return "hello word"
}, "/hello")
api.StartService(api.WithListen(":8080"))

2.eg.login

api.GET(func(username,password string) interface{} {
      return "hello word"
}, "/login")
api.StartService(api.WithListen(":8080"))

curl --location --request GET 'http://127.0.0.1:8011/login?username=alloce&password=123456'

upload file

api.POST(func(reader multipart.Reader) interface{} {
	form, _ := reader.ReadForm(0)
	fHeader := form.File["file"][0]
	f, _ := fHeader.Open()
	bytes,_:=ioutil.ReadAll(f)
	return bytes
}, "/fileUpload")
api.StartService(api.WithListen(":8080"))

curl --location --request GET 'http://127.0.0.1:8011/fileUpload' \
--form 'file=@"/C:/Users/Administrator/Downloads/README.MD"'

download file

api.GET(func() interface{} {
	f, _ := os.Open("C:/Users/Administrator/api/README.MD")
	return api.NewStream(f)
}, "/download")
api.StartService(api.WithListen(":8080"))

go build -gcflags all=-N -l

Documentation

Index

• Variables
• func StartService(ops ...Optional) error
• func StartTLSService(ops ...Optional) error
• type MiddlewareOps
  • func AddRoutes(os ...def.Option) *MiddlewareOps
  • func (m *MiddlewareOps) Middleware(mw ...def.MiddleWare) *MiddlewareOps
  • func (o *MiddlewareOps) Swagger(opsFn func(swagger def.SwaggerSecurity)) *MiddlewareOps
  • func (m *MiddlewareOps) WithPrefix(...def.MiddleWare) *MiddlewareOps
• type Optional
  • func WithCa(caPEMBlock []byte) Optional
  • func WithListen(s string) Optional
  • func WithTLS(certPEMBlock, keyPEMBlock []byte) Optional
  • func WithTLSFile(certFile, keyFile string) Optional
• type ServerConfig
  • func (c *ServerConfig) AddExclude(pkg ...string)
  • func (c *ServerConfig) AddIncludeRegex(regex ...string)
  • func (c *ServerConfig) Dwarf() *dwarf.DwarfMaker
  • func (c *ServerConfig) Listen() string
  • func (c *ServerConfig) LoadPath() *string
  • func (c *ServerConfig) SetDwarfMaker(dwarf *dwarf.DwarfMaker)
  • func (c *ServerConfig) SetDwarfMode(mode dwarf.FilterMode)
  • func (c *ServerConfig) SetExePath(path string)
  • func (c *ServerConfig) SetListen(ser string)
• type ServerMain
  • func NewServer(pool *def.MethodsPools) *ServerMain
  • func (ad *ServerMain) Maker() *dwarf.DwarfMaker
  • func (ad *ServerMain) ServeHTTP(rw http.ResponseWriter, req *http.Request)

Variables

var (
	HEAD    = core.HttpM(stdhttp.MethodHead, def.DefaultContext)
	GET     = core.HttpM(stdhttp.MethodGet, def.DefaultContext)
	POST    = core.HttpM(stdhttp.MethodPost, def.DefaultContext)
	PUT     = core.HttpM(stdhttp.MethodPut, def.DefaultContext)
	PATCH   = core.HttpM(stdhttp.MethodPatch, def.DefaultContext)
	DELETE  = core.HttpM(stdhttp.MethodDelete, def.DefaultContext)
	OPTIONS = core.HttpM(stdhttp.MethodOptions, def.DefaultContext)

	// RegisterErrorHandler error handler
	RegisterErrorHandler = http.RegisterErrorHandler

	// AddHttpHandle http handler
	AddHttpHandle = http.AddHttpHandle

	// RegisterTypeMapper type handler
	RegisterTypeMapper = call.RegisterTypeMapper

	// RegisterReturnHandler register handler
	RegisterReturnHandler = http.RegisterReturnHandler

	NewStream = rettypes.NewStream

	Html     = rettypes.NewHtml
	HtmlView = rettypes.HtmlView

	// Static static web
	Static = http.DefaultStatic.HandleStatic

	NewRedirect = rettypes.NewRedirect

	NewResp = rettypes.NewResp
)

Functions

func StartService

func StartService(ops ...Optional) error

func StartTLSService

func StartTLSService(ops ...Optional) error

Types

type MiddlewareOps

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

func AddRoutes

func AddRoutes(os ...def.Option) *MiddlewareOps

func (*MiddlewareOps) Middleware

func (m *MiddlewareOps) Middleware(mw ...def.MiddleWare) *MiddlewareOps

func (*MiddlewareOps) Swagger

func (o *MiddlewareOps) Swagger(opsFn func(swagger def.SwaggerSecurity)) *MiddlewareOps

func (*MiddlewareOps) WithPrefix

func (m *MiddlewareOps) WithPrefix(...def.MiddleWare) *MiddlewareOps

type Optional

type Optional func(conf *ServerConfig)

func WithCa

func WithCa(caPEMBlock []byte) Optional

func WithListen

func WithListen(s string) Optional

func WithTLS

func WithTLS(certPEMBlock, keyPEMBlock []byte) Optional

func WithTLSFile

func WithTLSFile(certFile, keyFile string) Optional

type ServerConfig

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

func (*ServerConfig) AddExclude

func (c *ServerConfig) AddExclude(pkg ...string)

func (*ServerConfig) AddIncludeRegex

func (c *ServerConfig) AddIncludeRegex(regex ...string)

func (*ServerConfig) Dwarf

func (c *ServerConfig) Dwarf() *dwarf.DwarfMaker

func (*ServerConfig) Listen

func (c *ServerConfig) Listen() string

func (*ServerConfig) LoadPath

func (c *ServerConfig) LoadPath() *string

func (*ServerConfig) SetDwarfMaker

func (c *ServerConfig) SetDwarfMaker(dwarf *dwarf.DwarfMaker)

func (*ServerConfig) SetDwarfMode

func (c *ServerConfig) SetDwarfMode(mode dwarf.FilterMode)

func (*ServerConfig) SetExePath

func (c *ServerConfig) SetExePath(path string)

func (*ServerConfig) SetListen

func (c *ServerConfig) SetListen(ser string)

type ServerMain

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

func NewServer

func NewServer(pool *def.MethodsPools) *ServerMain

func (*ServerMain) Maker

func (ad *ServerMain) Maker() *dwarf.DwarfMaker

func (*ServerMain) ServeHTTP

func (ad *ServerMain) ServeHTTP(rw http.ResponseWriter, req *http.Request)