rest

Documentation

Index

• type ErrorResponse
  • func (e ErrorResponse) Error() string
  • func (e ErrorResponse) StatusCode() int
• type TestRequest
  • func (t TestRequest) Info() request.HttpRouteInfo
• type TestResponse
• type TestService
  • func (t TestService) Execute(ctx context.Context, request interface{}) (response interface{}, err error)
  • func (t TestService) ExpectedResponses() service.MappedResponses
• type UnregisteredResponse

Types

type ErrorResponse

type ErrorResponse struct {
	Message string `json:"message"`
	Code    int    `json:"code"`
}

func (ErrorResponse) Error

func (e ErrorResponse) Error() string

func (ErrorResponse) StatusCode

func (e ErrorResponse) StatusCode() int

type TestRequest

type TestRequest struct {
	Name    string  `header:"Name-Var" description:"a name" required:"true"`
	Cost    float32 `query:"cost" required:"true"`
	NewPath string  `path:"path"`
	MayOmit string  `query:"mustHave" required:"false"`
	MayErr  bool    `query:"mayErr"`
	Cookie  string  `cookie:"testCookie"`
}

func (TestRequest) Info

func (t TestRequest) Info() request.HttpRouteInfo

type TestResponse

type TestResponse struct {
	Name      string  `json:"message"`
	Cost      float32 `json:"cost"`
	Path      string  `json:"path"`
	CookieVal string  `json:"cookieVal"`
	response.BasicResponse
	response.ExpandedLogging
}

type TestService

type TestService struct {
	gkBoot.BasicService
}

func (TestService) Execute

func (t TestService) Execute(ctx context.Context, request interface{}) (response interface{}, err error)

func (TestService) ExpectedResponses

func (t TestService) ExpectedResponses() service.MappedResponses

type UnregisteredResponse

type UnregisteredResponse struct {
	ImInvalid string `json:"invalid"`
}