Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

jsonapi

package module

Go to main page

Versions in this module

v0

v0.1.7

Feb 12, 2026

v0.1.6

Jan 16, 2026

Changes in this version

+ func UnmarshalPayloadWithLidMap(in io.Reader, model interface{}, generator IDGenerator) (map[string]string, error)

+ type IDGenerator interface

+ Generate func() (string, error)

+ type LidMap map[string]string

+ func (l LidMap) Exist(k string) bool

+ func (l LidMap) Get(k string) string

+ func (l LidMap) Set(k, v string)

v0.1.5

Dec 22, 2025

v0.1.4

Dec 22, 2025

v0.1.3

Nov 18, 2025

v0.1.2

Oct 29, 2025

v0.1.1

Oct 29, 2025

v0.1.0

Oct 28, 2025

Changes in this version

+ const KeyFirstPage

+ const KeyLastPage

+ const KeyNextPage

+ const KeyPreviousPage

+ const KeySelfLink

+ const MediaType

+ const QueryParamPageCursor

+ const QueryParamPageLimit

+ const QueryParamPageNumber

+ const QueryParamPageOffset

+ const QueryParamPageSize

+ var ErrBadJSONAPIID = errors.New("id should be either string, int(8,16,32,64) or uint(8,16,32,64)")

+ var ErrBadJSONAPIStructTag = errors.New("Bad jsonapi struct tag format")

+ var ErrExpectedSlice = errors.New("models should be a slice of struct pointers")

+ var ErrInvalidISO8601 = errors.New("Only strings can be parsed as dates, ISO8601 timestamps")

+ var ErrInvalidRFC3339 = errors.New("Only strings can be parsed as dates, RFC3339 timestamps")

+ var ErrInvalidTime = errors.New("Only numbers can be parsed as dates, unix timestamps")

+ var ErrInvalidType = errors.New("Invalid type provided")

+ var ErrTypeNotFound = errors.New("no primary type annotation found on model")

+ var ErrUnexpectedNil = errors.New("slice of struct pointers cannot contain nil")

+ var ErrUnexpectedType = errors.New("models should be a struct pointer or slice of struct pointers")

+ var ErrUnknownFieldNumberType = errors.New("The struct field was not of a known number type")

+ func MarshalErrors(w io.Writer, errorObjects []*ErrorObject) error

+ func MarshalOnePayloadEmbedded(w io.Writer, model interface{}) error

+ func MarshalPayload(w io.Writer, models interface{}) error

+ func MarshalPayloadWithoutIncluded(w io.Writer, model interface{}) error

+ func UnmarshalManyPayload(in io.Reader, t reflect.Type) ([]interface{}, error)

+ func UnmarshalPayload(in io.Reader, model interface{}) error

+ type ErrUnsupportedPtrType struct

+ func (eupt ErrUnsupportedPtrType) Error() string

+ type ErrorObject struct

+ Code string

+ Detail string

+ ID string

+ Meta *map[string]interface{}

+ Source *ErrorSource

+ Status string

+ Title string

+ func (e *ErrorObject) Error() string

+ type ErrorSource struct

+ Header string

+ Parameter string

+ Pointer string

+ type ErrorsPayload struct

+ Errors []*ErrorObject

+ type Event int

+ const MarshalStart

+ const MarshalStop

+ const UnmarshalStart

+ const UnmarshalStop

+ type Events func(*Runtime, Event, string, time.Duration)

+ var Instrumentation Events

+ type IncludeController interface

+ ShouldInclude func(relation string) bool

+ type Link struct

+ Href string

+ Meta Meta

+ type Linkable interface

+ JSONAPILinks func() *Links

+ type Links map[string]interface

+ type ManyPayload struct

+ Data []*Node

+ Included []*Node

+ Links *Links

+ Meta *Meta

+ type Meta map[string]interface

+ type Metable interface

+ JSONAPIMeta func() *Meta

+ type Node struct

+ Attributes map[string]interface{}

+ ClientID string

+ ID string

+ Lid string

+ Links *Links

+ Meta *Meta

+ Relationships map[string]interface{}

+ Type string

+ type NullableAttr map[bool]T

+ func NewNullNullableAttr[T any]() NullableAttr[T]

+ func NewNullableAttrWithValue[T any](t T) NullableAttr[T]

+ func (t *NullableAttr[T]) Set(value T)

+ func (t *NullableAttr[T]) SetInterface(value interface{})

+ func (t *NullableAttr[T]) SetNull()

+ func (t *NullableAttr[T]) SetUnspecified()

+ func (t NullableAttr[T]) Get() (T, error)

+ func (t NullableAttr[T]) IsNull() bool

+ func (t NullableAttr[T]) IsSpecified() bool

+ type NullableRelationship map[bool]T

+ func NewNullNullableRelationship[T any]() NullableRelationship[T]

+ func NewNullableRelationshipWithValue[T any](t T) NullableRelationship[T]

+ func (t *NullableRelationship[T]) Set(value T)

+ func (t *NullableRelationship[T]) SetInterface(value interface{})

+ func (t *NullableRelationship[T]) SetNull()

+ func (t *NullableRelationship[T]) SetUnspecified()

+ func (t NullableRelationship[T]) Get() (T, error)

+ func (t NullableRelationship[T]) IsNull() bool

+ func (t NullableRelationship[T]) IsSpecified() bool

+ type OnePayload struct

+ Data *Node

+ Included []*Node

+ Links *Links

+ Meta *Meta

+ type Payloader interface

+ func Marshal(models interface{}) (Payloader, error)

+ type RelationshipLinkable interface

+ JSONAPIRelationshipLinks func(relation string) *Links

+ type RelationshipManyNode struct

+ Data []*Node

+ Links *Links

+ Meta *Meta

+ type RelationshipMetable interface

+ JSONAPIRelationshipMeta func(relation string) *Meta

+ type RelationshipOneNode struct

+ Data *Node

+ Links *Links

+ Meta *Meta

+ type Runtime struct

+ func NewRuntime() *Runtime

+ func (r *Runtime) Instrument(key string) *Runtime

+ func (r *Runtime) MarshalPayload(w io.Writer, model interface{}) error

+ func (r *Runtime) UnmarshalManyPayload(reader io.Reader, kind reflect.Type) (elems []interface{}, err error)

+ func (r *Runtime) UnmarshalPayload(reader io.Reader, model interface{}) error

+ func (r *Runtime) Value(key string) interface{}

+ func (r *Runtime) WithValue(key string, value interface{}) *Runtime