rest

Documentation

Index

• Variables
• func New(o *Option) (r *router.Router)
• type Option
• type Response

Variables

var (
	ErrOption = errors.New("Must set NewModel when use PostFunc/PutFunc")
)

error(s)

var ErrResponse = &Response{
	Code: -1,
	Msg:  "FAIL",
}

ErrResponse Common

Functions

func New

func New(o *Option) (r *router.Router)

New RESTful Router

Types

type Option

type Option struct {
	Root        *router.Router
	UseNotFound bool
	NewModel    func() interface{}

	// Optional
	DefaultPageSize int
	Path            string
	GetFunc         func(id string) interface{}
	ListFunc        func(page, size int) interface{}
	PostFunc        func(interface{}) error
	PutFunc         func(interface{}) error
	DeleteFunc      func(id string) error
}

Option of RESTful Middleware

type Response

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

Response Common