api

Documentation

Index

• type API
  • func (api *API) Append(f func(api *API))
  • func (api *API) Cookie(name string, opts ...param.ReqParamOpts) *API
  • func (api *API) DealPathItem(operation *openapi3.Operation, opts []path.PathOpts) *API
  • func (api *API) Header(name string, opts ...param.ReqParamOpts) *API
  • func (api *API) NeedSecurify(tokenName string, require []string) *API
  • func (api *API) PageInQuery(pageName string, defaultPageNum int, pageSizeName string, ...) *API
  • func (api *API) Path(name string, opts ...param.ReqParamOpts) *API
  • func (api *API) Query(name string, opts ...param.ReqParamOpts) *API
  • func (api *API) ReqCustom(m model.Model, header string, opts ...req.ReqModelOpts) *API
  • func (api *API) ReqFormNoFile(m model.Model, opts ...req.ReqModelOpts) *API
  • func (api *API) ReqFormWithFile(m model.Model, opts ...req.ReqModelOpts) *API
  • func (api *API) ReqJSON(m model.Model, opts ...req.ReqModelOpts) *API
  • func (api *API) ResCustom(code int, header string, m model.Model, opts ...res.ResModelOpts) *API
  • func (api *API) ResJSON(code int, m model.Model, opts ...res.ResModelOpts) *API
  • func (api *API) ResString(code int, opts ...res.ResModelOpts) *API

Types

type API

type API struct {
	Operation *openapi3.Operation
	Schemas   *openapi3.Schemas
}

func (*API) Append

func (api *API) Append(f func(api *API))

If r5t API does not meet your requirements, you can modify certain things yourself using append operations. I hope it useful. api has Operation and Schemas, it can be directly update. like tests/TestAppend func

func (*API) Cookie

func (api *API) Cookie(name string, opts ...param.ReqParamOpts) *API

func (*API) DealPathItem

func (api *API) DealPathItem(operation *openapi3.Operation, opts []path.PathOpts) *API

deal all rest request 处理当前路径配置

func (*API) Header

func (api *API) Header(name string, opts ...param.ReqParamOpts) *API

func (*API) NeedSecurify

func (api *API) NeedSecurify(tokenName string, require []string) *API

func (*API) PageInQuery

func (api *API) PageInQuery(pageName string, defaultPageNum int, pageSizeName string, defaultPageSizeNum int) *API

PageInQuery is a convenient function for adding page and pageSize parameters to the API.

func (*API) Path

func (api *API) Path(name string, opts ...param.ReqParamOpts) *API

func (*API) Query

func (api *API) Query(name string, opts ...param.ReqParamOpts) *API

func (*API) ReqCustom

func (api *API) ReqCustom(m model.Model, header string, opts ...req.ReqModelOpts) *API

func (*API) ReqFormNoFile

func (api *API) ReqFormNoFile(m model.Model, opts ...req.ReqModelOpts) *API

func (*API) ReqFormWithFile

func (api *API) ReqFormWithFile(m model.Model, opts ...req.ReqModelOpts) *API

func (*API) ReqJSON

func (api *API) ReqJSON(m model.Model, opts ...req.ReqModelOpts) *API

func (*API) ResCustom

func (api *API) ResCustom(code int, header string, m model.Model, opts ...res.ResModelOpts) *API

func (*API) ResJSON

func (api *API) ResJSON(code int, m model.Model, opts ...res.ResModelOpts) *API

func (*API) ResString

func (api *API) ResString(code int, opts ...res.ResModelOpts) *API