jsonapi

Documentation

Index

• type Body
  • func BuildResponse(opts ...Option) *Body
  • func (b *Body) HTTPStatus() int
• type Error
  • func (e Error) Error() string
• type Errors
  • func (e Errors) Error() string
  • func (e Errors) HTTPStatus() int
• type Meta
• type Option
  • func WithData(data interface{}) Option
  • func WithErrors(errors Errors) Option
  • func WithException(code string, status int, exc exception.Exception) Option
  • func WithExceptionMeta(code string, status int, exc exception.Exception, meta Meta) Option
  • func WithMeta(key string, field interface{}) Option

Types

type Body

type Body struct {
	Data   interface{} `json:"data,omitempty"`
	Errors Errors      `json:"errors,omitempty"`
	Meta   Meta        `json:"meta,omitempty"`
}

func BuildResponse

func BuildResponse(opts ...Option) *Body

func (*Body) HTTPStatus

func (b *Body) HTTPStatus() int

type Error

type Error struct {
	Title  string `json:"title,omitempty"`
	Detail string `json:"detail,omitempty"`
	Code   string `json:"code,omitempty"`
	Status int    `json:"status,omitempty"`
	Meta   Meta   `json:"meta,omitempty"`
}

func (Error) Error

func (e Error) Error() string

type Errors

type Errors []Error

func (Errors) Error

func (e Errors) Error() string

func (Errors) HTTPStatus

func (e Errors) HTTPStatus() int

type Meta

type Meta map[string]interface{}

type Option

type Option func(*Body)

func WithData

func WithData(data interface{}) Option

func WithErrors

func WithErrors(errors Errors) Option

func WithException

func WithException(code string, status int, exc exception.Exception) Option

func WithExceptionMeta

func WithExceptionMeta(code string, status int, exc exception.Exception, meta Meta) Option

func WithMeta

func WithMeta(key string, field interface{}) Option