core

README

go-jsonapi-core

Documentation

Index

• Variables
• type Collection
• type Document
  • func New() Document
  • func (d *Document) AssertDataType() error
  • func (d *Document) ContentLength() int
  • func (d *Document) PopIncluded() Included
  • func (d Document) Size() int
  • func (d *Document) Version()
• type Error
  • func MakeError(status int) *Error
• type Implementation
• type Included
  • func (i Included) Find(r Resource) (*Resource, bool)
  • func (i Included) FindIndex(r Resource) (int, bool)
  • func (i Included) Merge(c Included) Included
  • func (i Included) MergeResource(r Resource) Included
• type Link
• type LinksObject
• type Resource
  • func (r Resource) Identify() Resource
• type SourceObject

Variables

var AssertionFailure = fmt.Errorf("type assertion failed")

Types

type Collection

type Collection []Resource

type Document

type Document struct {
	JSONAPI  *Implementation        `json:"jsonapi,omitempty"`
	Data     interface{}            `json:"data,omitempty"`
	Meta     map[string]interface{} `json:"meta,omitempty"`
	Links    LinksObject            `json:"links,omitempty"`
	Included Included               `json:"included,omitempty"`
	Errors   []Error                `json:"errors,omitempty"`
}

func New

func New() Document

func (*Document) AssertDataType

func (d *Document) AssertDataType() error

func (*Document) ContentLength

func (d *Document) ContentLength() int

func (*Document) PopIncluded

func (d *Document) PopIncluded() Included

func (Document) Size

func (d Document) Size() int

func (*Document) Version

func (d *Document) Version()

type Error

type Error struct {
	Error      error                  `json:"-"`
	Identifier string                 `json:"id,omitempty"`
	Links      *LinksObject           `json:"links,omitempty"`
	Status     string                 `json:"status,omitempty"`
	Code       string                 `json:"code,omitempty"`
	Title      string                 `json:"title,omitempty"`
	Detail     string                 `json:"detail,omitempty"`
	Source     *SourceObject          `json:"source,omitempty"`
	Meta       map[string]interface{} `json:"meta,omitempty"`
}

func MakeError

func MakeError(status int) *Error

type Implementation

type Implementation struct {
	Version string                 `json:"version,omitempty"`
	Meta    map[string]interface{} `json:"meta,omitempty"`
}

type Included

type Included []Resource

func (Included) Find

func (i Included) Find(r Resource) (*Resource, bool)

func (Included) FindIndex

func (i Included) FindIndex(r Resource) (int, bool)

func (Included) Merge

func (i Included) Merge(c Included) Included

func (Included) MergeResource

func (i Included) MergeResource(r Resource) Included

Merge a resource into the collection, such as for `Included`

type Link

type Link struct {
	Href string                 `json:"href,omitempty"`
	Meta map[string]interface{} `json:"meta,omitempty"`
}

type LinksObject

type LinksObject map[string]interface{}

type Resource

type Resource struct {
	Identifier    string                 `json:"id,omitempty"`
	Type          string                 `json:"type"`
	Attributes    map[string]interface{} `json:"attributes,omitempty"`
	Meta          map[string]interface{} `json:"meta,omitempty"`
	Relationships map[string]Document    `json:"relationships,omitempty"`
	// Links         map[string]string      `json:"links,omitempty"`
	Links LinksObject `json:"links,omitempty"`
}

func (Resource) Identify

func (r Resource) Identify() Resource

type SourceObject

type SourceObject struct {
	Pointer   string `json:"pointer,omitempty"`
	Parameter string `json:"parameter,omitempty"`
}