api

Documentation

Index

• type Handler
• type HandlerCheck
• type HandlerFunc
• type Page
  • func (p *Page[T]) Parse(s *Server[T], g *gin.Engine)
• type Server
  • func New[T any](client T) *Server[T]
  • func (s *Server[T]) Serve(addr ...string) (err error)

Types

type Handler

type Handler[T any] struct {
	Method  string
	Check   HandlerCheck[T]
	Handler HandlerFunc[T]
}

メソッドとハンダラの構造体

type HandlerCheck

type HandlerCheck[T any] func(*Server[T], *gin.Context) bool

type HandlerFunc

type HandlerFunc[T any] func(*Server[T], *gin.Context)

type Page

type Page[T any] struct {
	Path     string
	Handlers []*Handler[T]

	Child []*Page[T]
}

ページの構造を表す構造体

func (*Page[T]) Parse

func (p *Page[T]) Parse(s *Server[T], g *gin.Engine)

ページ構造を解析してginエンジンに登録する

ハンダラがnilだった場合無視される

type Server

type Server[T any] struct {
	sync.Mutex

	PageTree *Page[T]
	NoRoute  []gin.HandlerFunc
	NoMethod []gin.HandlerFunc

	Client T
	// contains filtered or unexported fields
}

APIサーバーの構造体

func New

func New[T any](client T) *Server[T]

新たなサーバー構造を生成する

func (*Server[T]) Serve

func (s *Server[T]) Serve(addr ...string) (err error)

ページを解析してサーバーを起動する