jsonapi

Documentation

Index

• func Stringify(v any) string
• type Error
  • func (j Error) JSONAPISerialize() (string, error)
• type ErrorCompatible
• type Errors
  • 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 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]
  • func NewErrors(errors Errors) *Root[Nil]
  • func NewMany(data Resources, includes Resources, meta Serializer) *Root[Resources]
  • func NewManyFrom[T Resourcer](list []T, meta Serializer) *Root[Resources]
  • func (j Root[T]) Serialize() (string, error)
• type Serializer
• type Serializers
  • func (s Serializers) JSONAPISerialize() (string, error)

Functions

func Stringify

func Stringify(v any) string

Types

type Error

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

func (Error) JSONAPISerialize

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

type ErrorCompatible

type ErrorCompatible interface {
	ToJSONAPIError() Error
}

type Errors

type Errors []Error

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 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]

func NewErrors

func NewErrors(errors Errors) *Root[Nil]

func NewMany

func NewMany(data Resources, includes Resources, meta Serializer) *Root[Resources]

func NewManyFrom

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

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)