jsonapi

package module

Go to main page

Versions in this module

v0

v0.5.0

Jul 29, 2024

Changes in this version

type Comparator

+ func ResourceComparator[S ~[]T, T any](arr S, m map[string]Comparer[T]) Comparator

+ type ComparatorFunc func(i, j int, attribute string) int

+ func (f ComparatorFunc) Compare(i, j int, attribute string) int

+ type Comparer func(a, b T) int

type Relationship

+ func (r Relationship) MarshalJSON() ([]byte, error)

v0.4.0

Jul 23, 2024

Changes in this version

+ func ValidateSpec(doc *Document) error

type Document

+ ValidateOnMarshal bool

+ type Specification interface

+ type SpecificationVersion string

+ const Version1_1

type Version

+ func (v Version) Value() string

v0.3.0

Jul 19, 2024

Changes in this version

type Many

+ func (m Many) First() *Resource

type One

+ func (o One) First() *Resource

type PrimaryData

+ First func() *Resource

v0.2.1

Jul 18, 2024

v0.2.0

Jun 9, 2024

Changes in this version

+ func Unmarshal(doc *Document, out any) error

type Resource

+ func (r *Resource) UnmarshalJSONAPI(other *Resource) error

+ func (r Resource) MarshalJSONAPI() (*Resource, error)

v0.1.0

Jun 8, 2024

Changes in this version

type Resource

+ func First(data PrimaryData) *Resource

v0.0.6

Jun 8, 2024

v0.0.5

Jun 8, 2024

v0.0.4

Jun 7, 2024

v0.0.3

Jun 7, 2024

v0.0.2

Jun 7, 2024

v0.0.1

May 17, 2024

Changes in this version

+ const LatestSupportedVersion

+ const MediaType

+ var ErrJSONAPI = errors.New("jsonapi error")

+ func Decode(r io.Reader, doc *Document) error

+ func Encode(w io.Writer, doc *Document) error

+ func Handler(handler RequestHandler, options ...func(*H)) http.Handler

+ func MarshalRaw(value any) (*json.RawMessage, error)

+ func RequestWithContext(r *http.Request, c *RequestContext) *http.Request

+ func Send(r Request, options ...func(*http.Request)) (*http.Response, error)

+ func SetContext(ctx context.Context, value *RequestContext) context.Context

+ func UnmarshalResource(node *Resource, out any) error

+ type Comparator interface

+ Compare func(i, j int, attribute string) int

+ type DefaultJSONEncoder struct

+ func (DefaultJSONEncoder) EncodeJSON(w io.Writer, value any) error

+ type Document struct

+ Data PrimaryData

+ Errors []*Error

+ Extensions map[string]*json.RawMessage

+ Included []*Resource

+ Jsonapi JSONAPI

+ Links Links

+ Meta Meta

+ func Marshal(in any) (Document, error)

+ func MarshalRef(in any, name string) (Document, error)

+ func NewMultiDocument(data ...*Resource) *Document

+ func NewSingleDocument(data *Resource) *Document

+ func (d *Document) ApplyVisitor(v *Visitor) error

+ func (d *Document) Sort(cmp Comparator, criterion []query.Sort)

+ func (d *Document) UnmarshalJSON(data []byte) error

+ func (d Document) Error() error

+ func (d Document) MarshalJSON() ([]byte, error)

+ type DocumentVisitor interface

+ VisitDocument func(obj *Document) error

+ type Doer interface

+ Do func(*http.Request) (*http.Response, error)

+ type Error struct

+ Code string

+ Detail string

+ ID string

+ Links Links

+ Meta Meta

+ Source *ErrorSource

+ Status string

+ Title string

+ func NewError(cause error, title string) Error

+ func (e Error) Error() string

+ type ErrorSource struct

+ Header string

+ Parameter string

+ Pointer string

+ type ErrorVisitor interface

+ VisitError func(obj *Error) error

+ type ExtensionsNode = map[string]*json.RawMessage

+ type H struct

+ func (h H) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type HandlerFunc func(*http.Request) Response

+ func (f HandlerFunc) RouteJSONAPI(ctx *RequestContext, r *http.Request) Response

+ func (f HandlerFunc) ServeJSONAPI(r *http.Request) Response

+ type HrefLang []string

+ func (h *HrefLang) UnmarshalJSON(data []byte) error

+ func (h HrefLang) MarshalJSON() ([]byte, error)

+ type JSONAPI struct

+ Ext []string

+ Meta map[string]any

+ Profile []string

+ Version Version

+ type JSONEncoder interface

+ EncodeJSON func(w io.Writer, value any) error

+ type Link struct

+ Href string

+ HrefLang HrefLang

+ Meta Meta

+ Rel string

+ Title string

+ Type string

+ func (l *Link) UnmarshalJSON(data []byte) error

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

+ type Links = map[string]*Link

+ type LinksMarshaler interface

+ MarshalLinksJSONAPI func() Links

+ type LinksUnmarshaler interface

+ UnmarshalLinksJSONAPI func(Links)

+ type LinksVisitor interface

+ VisitLink func(obj *Link) error

+ VisitLinks func(obj Links) error

+ type Many struct

+ Value []*Resource

+ func (Many) IsMany() bool

+ func (m *Many) UnmarshalJSON(data []byte) error

+ func (m Many) Items() []*Resource

+ func (m Many) MarshalJSON() ([]byte, error)

+ type Meta = map[string]any

+ type MetaMarshaler interface

+ MarshalMetaJSONAPI func() Meta

+ type MetaUnmarshaler interface

+ UnmarshalMetaJSONAPI func(Meta)

+ type MetaVisitor interface

+ VisitMeta func(obj Meta) error

+ type Middleware func(next RequestHandler) RequestHandler

+ func Passthrough() Middleware

+ func (fn Middleware) Use(middleware Middleware) Middleware

+ func (fn Middleware) Wrap(handler RequestHandler) RequestHandler

+ type One struct

+ Value *Resource

+ func (One) IsMany() bool

+ func (o *One) UnmarshalJSON(data []byte) error

+ func (o One) IsNull() bool

+ func (o One) Items() []*Resource

+ func (o One) MarshalJSON() ([]byte, error)

+ type PartialVisitor struct

+ Document VisitorFunc[*Document]

+ Error VisitorFunc[*Error]

+ Link VisitorFunc[*Link]

+ Links VisitorFunc[Links]

+ Meta VisitorFunc[Meta]

+ Ref VisitorFunc[*Resource]

+ Relationship VisitorFunc[*Relationship]

+ Relationships VisitorFunc[RelationshipsNode]

+ Resource VisitorFunc[*Resource]

+ func (v *PartialVisitor) Visitor() *Visitor

+ func (v PartialVisitor) VisitDocument(obj *Document) error

+ func (v PartialVisitor) VisitError(obj *Error) error

+ func (v PartialVisitor) VisitLink(obj *Link) error

+ func (v PartialVisitor) VisitLinks(obj Links) error

+ func (v PartialVisitor) VisitMeta(obj Meta) error

+ func (v PartialVisitor) VisitRef(obj *Resource) error

+ func (v PartialVisitor) VisitRelationship(obj *Relationship) error

+ func (v PartialVisitor) VisitRelationships(obj RelationshipsNode) error

+ func (v PartialVisitor) VisitResource(obj *Resource) error

+ type PrimaryData interface

+ IsMany func() bool

+ Items func() []*Resource

+ type RelatedLinksMarshaler interface

+ MarshalRelatedLinksJSONAPI func(name string) Links

+ type RelatedLinksUnmarshaler interface

+ UnmarshalRelatedLinksJSONAPI func(name string, links Links)

+ type RelatedMetaMarshaler interface

+ MarshalRelatedMetaJSONAPI func(name string) Meta

+ type RelatedMetaUnmarshaler interface

+ UnmarshalRelatedMetaJSONAPI func(name string, meta Meta)

+ type Relationship struct

+ Data PrimaryData

+ Links Links

+ Meta Meta

+ func (r *Relationship) UnmarshalJSON(data []byte) error

+ type RelationshipVisitor interface

+ VisitRef func(obj *Resource) error

+ VisitRelationship func(obj *Relationship) error

+ VisitRelationships func(obj RelationshipsNode) error

+ type RelationshipsNode = map[string]*Relationship

+ type Request struct

+ BaseURL string

+ Client Doer

+ Context RequestContext

+ Method string

+ func NewRequest(baseURL string, options ...func(*Request)) Request

+ func (r Request) AddRefsToMany(data Resource, ref string, options ...func(*http.Request)) (*http.Response, error)

+ func (r Request) Create(data Resource, options ...func(*http.Request)) (*http.Response, error)

+ func (r Request) Delete(resourceType, id string, options ...func(*http.Request)) (*http.Response, error)

+ func (r Request) Get(resourceType, id string, options ...func(*http.Request)) (*http.Response, error)

+ func (r Request) GetRef(resourceType, id, ref string, options ...func(*http.Request)) (*http.Response, error)

+ func (r Request) GetRelated(resourceType, id, relation string, options ...func(*http.Request)) (*http.Response, error)

+ func (r Request) HTTPRequest() (*http.Request, error)

+ func (r Request) List(resourceType string, options ...func(*http.Request)) (*http.Response, error)

+ func (r Request) RemoveRefsFromMany(data Resource, ref string, options ...func(*http.Request)) (*http.Response, error)

+ func (r Request) Update(data Resource, options ...func(*http.Request)) (*http.Response, error)

+ func (r Request) UpdateRef(data Resource, ref string, options ...func(*http.Request)) (*http.Response, error)

+ type RequestContext struct

+ Document *Document

+ FetchIDs []string

+ Fields []query.Fieldset

+ Filter query.FilterExpression

+ Include []string

+ Pagination query.Page

+ Related bool

+ Relationship string

+ ResourceID string

+ ResourceType string

+ Sort []query.Sort

+ func GetContext(parent context.Context) (*RequestContext, bool)

+ func (c *RequestContext) Child() *RequestContext

+ func (c *RequestContext) EmptyChild() *RequestContext

+ func (c RequestContext) Clone() *RequestContext

+ func (c RequestContext) Parent() *RequestContext

+ func (c RequestContext) Root() *RequestContext

+ type RequestContextResolver interface

+ ResolveContext func(*http.Request) (RequestContext, error)

+ type RequestContextResolverFunc func(*http.Request) (RequestContext, error)

+ func DefaultRequestContextResolver() RequestContextResolverFunc

+ func (fn RequestContextResolverFunc) ResolveContext(r *http.Request) (RequestContext, error)

+ type RequestHandler interface

+ ServeJSONAPI func(*http.Request) Response

+ type Resource struct

+ Attributes map[string]any

+ Extensions ExtensionsNode

+ ID string

+ Links Links

+ LocalID string

+ Meta Meta

+ Relationships RelationshipsNode

+ Type string

+ func MarshalResource(in any) (*Resource, error)

+ func (r *Resource) UnmarshalJSON(data []byte) error

+ func (r Resource) MarshalJSON() ([]byte, error)

+ func (r Resource) Ref() *Resource

+ type ResourceMarshaler interface

+ MarshalJSONAPI func() (*Resource, error)

+ type ResourceUnmarshaler interface

+ UnmarshalJSONAPI func(*Resource) error

+ type ResourceVisitor interface

+ VisitResource func(obj *Resource) error

+ type Response struct

+ Body *Document

+ Code int

+ Headers map[string]string

+ func NewResponse(status int, opts ...ResponseOption) Response

+ func (r *Response) AppendError(cause error)

+ func (r *Response) ApplyOptions(opts ...ResponseOption)

+ func (r Response) WriteResponse(w http.ResponseWriter, opts ...ResponseOption) (int, error)

+ type ResponseOption = func(*Response)

+ type URLResolver interface

+ ResolveURL func(ctx RequestContext, baseURL string) string

+ type URLResolverFunc func(RequestContext, string) string

+ func DefaultURLResolver() URLResolverFunc

+ func (fn URLResolverFunc) ResolveURL(ctx RequestContext, baseURL string) string

+ type Version string

+ func (v Version) MarshalJSON() ([]byte, error)

+ type Visitor struct

+ type VisitorFunc func(Node) error

Other modules containing this package

github.com/gonobo/jsonapi/v2

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