jsonapi

Documentation

Index

• func Stringify(v any) string
• type Attributes
  • func NewAttributes[T any](v T) Attributes[T]
  • func (a Attributes[T]) JSONAPISerialize() (string, error)
• type CodeGetter
• type Errable
  • func NewInternalServerError(err error) Errable
• type Error
  • func NewBadRequest(err error) Error
  • func NewForbidden(err error) Error
  • func NewNotFound(err error) Error
  • func NewUnauthorized(err error) Error
  • func (j Error) Error() string
  • func (j Error) JSONAPISerialize() (string, error)
• type ErrorResponse
  • func NewErrorResponse(err error) *ErrorResponse
  • func (e ErrorResponse) Code() string
  • func (e ErrorResponse) Error() string
  • func (e ErrorResponse) Title() string
  • func (e ErrorResponse) ToJSONAPIError() Error
• type Errors
  • func (j Errors) Error() string
  • func (j Errors) JSONAPISerialize() (string, error)
• type Nil
  • func (n Nil) JSONAPISerialize() (string, error)
• type Relationship
  • func (j Relationship) JSONAPISerialize() (string, error)
• type RelationshipHasMany
  • func (j RelationshipHasMany) JSONAPISerialize() (string, error)
• type Relationships
  • func (j Relationships) JSONAPISerialize() (string, error)
• type Resource
  • func (j Resource) JSONAPISerialize() (string, error)
• type ResourceIdentifier
  • func (j ResourceIdentifier) JSONAPISerialize() (string, error)
• type Resourcer
• type Resourcers
  • func (r Resourcers) ToJSONAPIResource() (Resources, Resources)
• type Resources
  • func (j *Resources) Append(r ...Resource)
  • func (j Resources) JSONAPISerialize() (string, error)
• type Root
  • func New(data Resource, includes Resources, meta Serializer) (*Root[Resource], error)
  • func NewErrors(errors Errors) *Root[Nil]
  • func NewManyFrom[T Resourcer](list []T, meta Serializer) (*Root[Resources], error)
  • func (j Root[T]) Serialize() (string, error)
• type Serializer
• type Serializers
  • func (s Serializers) JSONAPISerialize() (string, error)
• type TitleGetter

Functions

func Stringify

func Stringify(v any) string

Types

type Attributes

type Attributes[T any] struct {
	// contains filtered or unexported fields
}

func NewAttributes

func NewAttributes[T any](v T) Attributes[T]

func (Attributes[T]) JSONAPISerialize

func (a Attributes[T]) JSONAPISerialize() (string, error)

type CodeGetter

type CodeGetter interface {
	Code() string
}

type Errable

type Errable interface {
	ToJSONAPIError() Error
	Error() string
}

func NewInternalServerError

func NewInternalServerError(err error) Errable

type Error

type Error struct {
	ID     string
	Status int
	Code   string
	Title  string
	Detail string
}

func NewBadRequest

func NewBadRequest(err error) Error

func NewForbidden

func NewForbidden(err error) Error

func NewNotFound

func NewNotFound(err error) Error

func NewUnauthorized

func NewUnauthorized(err error) Error

func (Error) Error

func (j Error) Error() string

func (Error) JSONAPISerialize

func (j Error) JSONAPISerialize() (string, error)

type ErrorResponse

type ErrorResponse struct {
	// contains filtered or unexported fields
}

func NewErrorResponse

func NewErrorResponse(err error) *ErrorResponse

func (ErrorResponse) Code

func (e ErrorResponse) Code() string

func (ErrorResponse) Error

func (e ErrorResponse) Error() string

func (ErrorResponse) Title

func (e ErrorResponse) Title() string

func (ErrorResponse) ToJSONAPIError

func (e ErrorResponse) ToJSONAPIError() Error

type Errors

type Errors []Error

func (Errors) Error

func (j Errors) Error() string

func (Errors) JSONAPISerialize

func (j Errors) JSONAPISerialize() (string, error)

type Nil

type Nil struct{}

func (Nil) JSONAPISerialize

func (n Nil) JSONAPISerialize() (string, error)

type Relationship

type Relationship struct {
	Data ResourceIdentifier
}

func (Relationship) JSONAPISerialize

func (j Relationship) JSONAPISerialize() (string, error)

type RelationshipHasMany

type RelationshipHasMany struct {
	Data []ResourceIdentifier
}

func (RelationshipHasMany) JSONAPISerialize

func (j RelationshipHasMany) JSONAPISerialize() (string, error)

type Relationships

type Relationships map[string]Serializer

func (Relationships) JSONAPISerialize

func (j Relationships) JSONAPISerialize() (string, error)

type Resource

type Resource struct {
	ID            string
	Type          string
	Attributes    Serializer
	Relationships Relationships
}

func (Resource) JSONAPISerialize

func (j Resource) JSONAPISerialize() (string, error)

type ResourceIdentifier

type ResourceIdentifier struct {
	ID   string
	Type string
}

func (ResourceIdentifier) JSONAPISerialize

func (j ResourceIdentifier) JSONAPISerialize() (string, error)

type Resourcer

type Resourcer interface {
	ToJSONAPIResource() (data Resource, included Resources)
}

type Resourcers

type Resourcers []Resourcer

func (Resourcers) ToJSONAPIResource

func (r Resourcers) ToJSONAPIResource() (Resources, Resources)

type Resources

type Resources struct {
	Data []Resource
	// contains filtered or unexported fields
}

func (*Resources) Append

func (j *Resources) Append(r ...Resource)

func (Resources) JSONAPISerialize

func (j Resources) JSONAPISerialize() (string, error)

type Root

type Root[T Serializer] struct {
	Data     T
	Errors   Errors
	Meta     Serializer
	Included Resources
}

func New

func New(data Resource, includes Resources, meta Serializer) (*Root[Resource], error)

func NewErrors

func NewErrors(errors Errors) *Root[Nil]

func NewManyFrom

func NewManyFrom[T Resourcer](list []T, meta Serializer) (*Root[Resources], error)

func (Root[T]) Serialize

func (j Root[T]) Serialize() (string, error)

type Serializer

type Serializer interface {
	JSONAPISerialize() (string, error)
}

type Serializers

type Serializers []Serializer

func (Serializers) JSONAPISerialize

func (s Serializers) JSONAPISerialize() (string, error)

type TitleGetter

type TitleGetter interface {
	Title() string
}