jsonapi

package module

Go to main page

Versions in this module

v0

v0.21.0

Oct 8, 2022

Changes in this version

type Params

+ Page map[string]interface{}

type SimpleURL

+ Page map[string]interface{}

v0.20.0

Jun 24, 2021

Changes in this version

+ type Copier interface

+ Copy func() Resource

+ New func() Resource

v0.19.0

Jan 6, 2021

Changes in this version

+ type Meta map[string]interface

+ func (m Meta) GetBool(key string) bool

+ func (m Meta) GetInt(key string) int

+ func (m Meta) GetString(key string) string

+ func (m Meta) GetTime(key string) time.Time

+ func (m Meta) Has(key string) bool

+ type MetaHolder interface

+ Meta func() Meta

+ SetMeta func(Meta)

type Schema

+ func (s *Schema) AddTwoWayRel(rel Rel) error

type SoftResource

+ func (sr *SoftResource) Meta() Meta

+ func (sr *SoftResource) SetMeta(m Meta)

type Wrapper

+ func (w *Wrapper) Meta() Meta

+ func (w *Wrapper) SetMeta(m Meta)

v0.18.1

Mar 15, 2020

v0.18.0

Mar 7, 2020

v0.17.0

Jan 18, 2020

v0.16.2

Dec 5, 2019

v0.16.1

Nov 26, 2019

v0.16.0

Nov 10, 2019

Changes in this version

+ func MarshalCollection(c Collection, prepath string, fields map[string][]string, ...) []byte

+ func MarshalDocument(doc *Document, url *URL) ([]byte, error)

+ func MarshalResource(r Resource, prepath string, fields []string, relData map[string][]string) []byte

type Collection

+ func UnmarshalCollection(data []byte, schema *Schema) (Collection, error)

type Document

+ func UnmarshalDocument(payload []byte, schema *Schema) (*Document, error)

type Identifier

+ func UnmarshalIdentifier(payload []byte, schema *Schema) (Identifier, error)

type Rel

+ func (r *Rel) Invert() Rel

+ func (r Rel) String() string

type Resource

+ func UnmarshalResource(data []byte, schema *Schema) (Resource, error)

type SoftResource

+ func UnmarshalPartialResource(data []byte, schema *Schema) (*SoftResource, error)

type Type

+ func (t Type) Copy() Type

v0.15.0

Oct 13, 2019

Changes in this version

+ const AttrTypeBytes

v0.14.0

Aug 30, 2019

Changes in this version

type Attr

+ func (a Attr) UnmarshalToType(data []byte) (interface{}, error)

type BelongsToFilter

+ ToName string

type Collection

+ func Range(c Collection, ids []string, filter *Filter, sort []string, size uint, num uint) Collection

type Document

+ func UnmarshalIdentifiers(payload []byte, schema *Schema) (*Document, error)

type Error

+ func NewErrInvalidFieldValueInBody(field string, badValue string, typ string) Error

+ func NewErrMissingDataMember() Error

type Rel

+ FromName string

+ FromOne bool

+ FromType string

+ ToName string

+ ToType string

+ func (r *Rel) Normalize() Rel

+ type Resources []Resource

+ func (r *Resources) Add(res Resource)

+ func (r *Resources) At(i int) Resource

+ func (r *Resources) GetType() Type

+ func (r *Resources) Len() int

type Schema

+ func (s *Schema) Rels() []Rel

type Type

+ NewFunc func() Resource

+ func BuildType(v interface{}) (Type, error)

+ func MustBuildType(v interface{}) Type

+ func (t *Type) New() Resource

+ func (t Type) Equal(typ Type) bool

v0.13.0

Aug 4, 2019

Changes in this version

+ func Check(v interface{}) error

type Error

+ func NewErrDuplicateFieldInFieldsParameter(typ string, field string) Error

type Type

+ func MustReflect(v interface{}) Type

+ func Reflect(v interface{}) (Type, error)

v0.12.0

Jul 28, 2019

Changes in this version

type Collection

+ At func(i int) Resource

+ GetType func() Type

type SoftCollection

+ func (s *SoftCollection) At(i int) Resource

type SoftResource

+ Type *Type

type Type

+ func CopyType(typ Type) Type

type URL

+ func NewURLFromRaw(schema *Schema, rawurl string) (*URL, error)

+ func (u *URL) String() string

+ func (u *URL) UnescapedString() string

type WrapperCollection

+ func (wc *WrapperCollection) At(i int) Resource

+ func (wc *WrapperCollection) GetType() Type

v0.11.0

Jul 1, 2019

Changes in this version

+ const AttrTypeUint64

type Attr

+ Nullable bool

+ type Filter struct

+ Col string

+ Field string

+ Op string

+ Val interface{}

+ func (f *Filter) IsAllowed(res Resource) bool

+ func (f *Filter) MarshalJSON() ([]byte, error)

+ func (f *Filter) UnmarshalJSON(data []byte) error

type SoftCollection

+ func (s *SoftCollection) GetType() *Type

+ func (s *SoftCollection) SetType(typ *Type)

v0.10.0

Jun 11, 2019

Changes in this version

+ func EqualStrict(r1, r2 Resource) bool

+ type SoftCollection struct

+ Type *Type

+ func (s *SoftCollection) Add(r Resource)

+ func (s *SoftCollection) AddAttr(attr Attr) error

+ func (s *SoftCollection) AddRel(rel Rel) error

+ func (s *SoftCollection) Elem(i int) Resource

+ func (s *SoftCollection) Len() int

+ func (s *SoftCollection) Less(i, j int) bool

+ func (s *SoftCollection) Range(ids []string, _ *Condition, sort []string, fields []string, pageSize uint, ...) []Resource

+ func (s *SoftCollection) Remove(id string)

+ func (s *SoftCollection) Resource(id string, fields []string) Resource

+ func (s *SoftCollection) Sort(rules []string)

+ func (s *SoftCollection) Swap(i, j int)

+ func (s *SoftCollection) UnmarshalJSON(payload []byte) error

v0.9.0

Apr 28, 2019

v0.8.0

Apr 22, 2019

Changes in this version

+ type Request struct

+ Doc *Document

+ Method string

+ URL *URL

+ func NewRequest(r *http.Request, schema *Schema) (*Request, error)

type Schema

+ func NewMockSchema() *Schema

+ func (s *Schema) GetResource(name string) Resource

type Type

+ func ReflectType(v interface{}) (Type, error)

v0.7.0

Mar 24, 2019

Changes in this version

+ const AttrTypeBool

+ const AttrTypeInt

+ const AttrTypeInt16

+ const AttrTypeInt32

+ const AttrTypeInt64

+ const AttrTypeInt8

+ const AttrTypeInvalid

+ const AttrTypeString

+ const AttrTypeTime

+ const AttrTypeUint

+ const AttrTypeUint16

+ const AttrTypeUint32

+ const AttrTypeUint8

+ func Equal(r1, r2 Resource) bool

+ func GetAttrType(t string) (int, bool)

+ func GetAttrTypeString(t int, null bool) string

+ func GetZeroValue(t int, null bool) interface

+ func StrictEqual(r1, r2 Resource) bool

+ type Schema struct

+ Types []Type

+ func (s *Schema) AddAttr(typ string, attr Attr) error

+ func (s *Schema) AddRel(typ string, rel Rel) error

+ func (s *Schema) AddType(typ Type) error

+ func (s *Schema) Check() []error

+ func (s *Schema) GetType(name string) (Type, bool)

+ func (s *Schema) HasType(name string) bool

+ func (s *Schema) RemoveAttr(typ string, attr string) error

+ func (s *Schema) RemoveRel(typ string, rel string) error

+ func (s *Schema) RemoveType(typ string) error

+ type SoftResource struct

+ func NewSoftResource(typ Type, vals map[string]interface{}) *SoftResource

+ func (sr *SoftResource) AddAttr(attr Attr)

+ func (sr *SoftResource) AddRel(rel Rel)

+ func (sr *SoftResource) Attr(key string) Attr

+ func (sr *SoftResource) Attrs() map[string]Attr

+ func (sr *SoftResource) Copy() Resource

+ func (sr *SoftResource) Get(key string) interface{}

+ func (sr *SoftResource) GetID() string

+ func (sr *SoftResource) GetToMany(key string) []string

+ func (sr *SoftResource) GetToOne(key string) string

+ func (sr *SoftResource) GetType() string

+ func (sr *SoftResource) New() Resource

+ func (sr *SoftResource) Rel(key string) Rel

+ func (sr *SoftResource) Rels() map[string]Rel

+ func (sr *SoftResource) RemoveField(field string)

+ func (sr *SoftResource) Set(key string, v interface{})

+ func (sr *SoftResource) SetID(id string)

+ func (sr *SoftResource) SetToMany(key string, rels []string)

+ func (sr *SoftResource) SetToOne(key string, rel string)

+ func (sr *SoftResource) SetType(name string)

+ func (sr *SoftResource) UnmarshalJSON(payload []byte) error

+ func (sr *SoftResource) Validate() []error

type Type

+ func (t *Type) AddAttr(attr Attr) error

+ func (t *Type) AddRel(rel Rel) error

+ func (t *Type) RemoveAttr(attr string) error

+ func (t *Type) RemoveRel(rel string) error

v0.6.0

Feb 17, 2019

Changes in this version

+ func CheckType(v interface{}) error

+ func IDAndType(v interface{}) (string, string)

+ func Marshal(doc *Document, url *URL) ([]byte, error)

+ func MarshalIdentifiers(ids []string, toOne bool) json.RawMessage

+ type Attr struct

+ Name string

+ Null bool

+ Type string

+ type BelongsToFilter struct

+ ID string

+ InverseName string

+ Name string

+ Type string

+ type Collection interface

+ Add func(r Resource)

+ Elem func(i int) Resource

+ Len func() int

+ Sample func() Resource

+ Type func() string

+ UnmarshalJSON func(payload []byte) error

+ type Condition struct

+ Col string

+ Field string

+ Op string

+ Val interface{}

+ func (c *Condition) MarshalJSON() ([]byte, error)

+ func (c *Condition) UnmarshalJSON(data []byte) error

+ type Document struct

+ Data interface{}

+ Errors []Error

+ Included map[string]Resource

+ Links map[string]Link

+ Meta map[string]interface{}

+ PrePath string

+ RelData map[string][]string

+ Resources map[string]map[string]struct{}

+ func NewDocument() *Document

+ func (d *Document) Include(res Resource)

+ type Error struct

+ Code string

+ Detail string

+ ID string

+ Links map[string]string

+ Meta map[string]interface{}

+ Source map[string]interface{}

+ Status int

+ Title string

+ func NewErrBadRequest(title, detail string) Error

+ func NewErrForbidden() Error

+ func NewErrInternalServerError() Error

+ func NewErrInvalidPageNumberParameter(badPageNumber string) Error

+ func NewErrInvalidPageSizeParameter(badPageSize string) Error

+ func NewErrInvalidValueInFilterParameter(val, kind string) Error

+ func NewErrMalformedFilterParameter(badFitler string) Error

+ func NewErrNotFound() Error

+ func NewErrNotImplemented() Error

+ func NewErrPayloadTooLarge() Error

+ func NewErrRequestHeaderFieldsTooLarge() Error

+ func NewErrRequestURITooLong() Error

+ func NewErrServiceUnavailable() Error

+ func NewErrTooManyRequests() Error

+ func NewErrUnauthorized() Error

+ func NewErrUnknownCollationInFilterParameter(col string) Error

+ func NewErrUnknownFieldInBody(typ, field string) Error

+ func NewErrUnknownFieldInFilterParameter(field string) Error

+ func NewErrUnknownFieldInURL(field string) Error

+ func NewErrUnknownFilterParameterLabel(label string) Error

+ func NewErrUnknownOperatorInFilterParameter(op string) Error

+ func NewErrUnknownParameter(param string) Error

+ func NewErrUnknownRelationshipInPath(typ, rel, path string) Error

+ func NewErrUnknownTypeInURL(typ string) Error

+ func NewErrUnsupportedMediaType() Error

+ func NewError() Error

+ func (e Error) Error() string

+ func (e Error) MarshalJSON() ([]byte, error)

+ type Identifier struct

+ ID string

+ Type string

+ type Identifiers []Identifier

+ func NewIdentifiers(t string, ids []string) Identifiers

+ func (i Identifiers) IDs() []string

+ type Link struct

+ HRef string

+ Meta map[string]interface{}

+ func (l Link) MarshalJSON() ([]byte, error)

+ type MockType1 struct

+ Bool bool

+ ID string

+ Int int

+ Int16 int16

+ Int32 int32

+ Int64 int64

+ Int8 int8

+ Str string

+ Time time.Time

+ ToMany []string

+ ToManyFromMany []string

+ ToManyFromOne []string

+ ToOne string

+ ToOneFromMany string

+ ToOneFromOne string

+ Uint uint

+ Uint16 uint16

+ Uint32 uint32

+ Uint8 uint8

+ type MockType2 struct

+ BoolPtr *bool

+ ID string

+ Int16Ptr *int16

+ Int32Ptr *int32

+ Int64Ptr *int64

+ Int8Ptr *int8

+ IntPtr *int

+ StrPtr *string

+ TimePtr *time.Time

+ ToManyFromMany []string

+ ToManyFromOne []string

+ ToOneFromMany string

+ ToOneFromOne string

+ Uint16Ptr *uint16

+ Uint32Ptr *uint32

+ Uint8Ptr *uint8

+ UintPtr *uint

+ type MockType3 struct

+ Attr1 string

+ Attr2 int

+ ID string

+ Rel1 string

+ Rel2 []string

+ type Params struct

+ Attrs map[string][]Attr

+ Fields map[string][]string

+ Filter *Condition

+ FilterLabel string

+ Include [][]Rel

+ PageNumber int

+ PageSize int

+ RelData map[string][]string

+ Rels map[string][]Rel

+ SortingRules []string

+ func NewParams(reg *Registry, su SimpleURL, resType string) (*Params, error)

+ type Payload struct

+ Data interface{}

+ Included map[string]Resource

+ JSONAPI map[string]interface{}

+ Meta map[string]interface{}

+ func Unmarshal(payload []byte, url *URL, reg *Registry) (*Payload, error)

+ type Registry struct

+ Types map[string]Type

+ func NewMockRegistry() *Registry

+ func NewRegistry() *Registry

+ func (r *Registry) Check() []error

+ func (r *Registry) Collection(name string) Collection

+ func (r *Registry) RegisterType(v interface{})

+ func (r *Registry) Resource(name string) Resource

+ type Rel struct

+ InverseName string

+ InverseToOne bool

+ InverseType string

+ Name string

+ ToOne bool

+ Type string

+ func (r *Rel) Inverse() Rel

+ type Resource interface

+ Attr func(key string) Attr

+ Attrs func() []Attr

+ Copy func() Resource

+ Get func(key string) interface{}

+ GetID func() string

+ GetToMany func(key string) []string

+ GetToOne func(key string) string

+ GetType func() string

+ New func() Resource

+ Rel func(key string) Rel

+ Rels func() []Rel

+ Set func(key string, val interface{})

+ SetID func(id string)

+ SetToMany func(key string, rels []string)

+ SetToOne func(key string, rel string)

+ UnmarshalJSON func(payload []byte) error

+ Validate func() []error

+ type SimpleURL struct

+ Fields map[string][]string

+ Filter *Condition

+ FilterLabel string

+ Fragments []string

+ Include []string

+ PageNumber int

+ PageSize int

+ Route string

+ SortingRules []string

+ func NewSimpleURL(u *url.URL) (SimpleURL, error)

+ func (s *SimpleURL) Path() string

+ type Type struct

+ Attrs map[string]Attr

+ Default Resource

+ Fields []string

+ Name string

+ Rels map[string]Rel

+ type URL struct

+ BelongsToFilter BelongsToFilter

+ Fragments []string

+ IsCol bool

+ Params *Params

+ Rel Rel

+ RelKind string

+ ResID string

+ ResType string

+ Route string

+ func NewURL(reg *Registry, su SimpleURL) (*URL, error)

+ func ParseRawURL(reg *Registry, rawurl string) (*URL, error)

+ func (u *URL) FullURL() string

+ func (u *URL) NormalizePath() string

+ type Wrapper struct

+ func Wrap(v interface{}) *Wrapper

+ func (w *Wrapper) Attr(key string) Attr

+ func (w *Wrapper) Attrs() []Attr

+ func (w *Wrapper) Copy() Resource

+ func (w *Wrapper) Get(key string) interface{}

+ func (w *Wrapper) GetID() string

+ func (w *Wrapper) GetToMany(key string) []string

+ func (w *Wrapper) GetToOne(key string) string

+ func (w *Wrapper) GetType() string

+ func (w *Wrapper) IDAndType() (string, string)

+ func (w *Wrapper) New() Resource

+ func (w *Wrapper) Rel(key string) Rel

+ func (w *Wrapper) Rels() []Rel

+ func (w *Wrapper) Set(key string, val interface{})

+ func (w *Wrapper) SetID(id string)

+ func (w *Wrapper) SetToMany(key string, rels []string)

+ func (w *Wrapper) SetToOne(key string, rel string)

+ func (w *Wrapper) UnmarshalJSON(payload []byte) error

+ func (w *Wrapper) Validate() []error

+ type WrapperCollection struct

+ func WrapCollection(r Resource) *WrapperCollection

+ func (wc *WrapperCollection) Add(r Resource)

+ func (wc *WrapperCollection) Elem(i int) Resource

+ func (wc *WrapperCollection) Len() int

+ func (wc *WrapperCollection) Sample() Resource

+ func (wc *WrapperCollection) Type() string

+ func (wc *WrapperCollection) UnmarshalJSON(payload []byte) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL