forked from Mirrors/jsonapi
88 lines
2.8 KiB
Go
88 lines
2.8 KiB
Go
package jsonapi
|
||
|
||
import "fmt"
|
||
|
||
// OnePayload is used to represent a generic JSON API payload where a single
|
||
// resource (Node) was included as an {} in the "data" key
|
||
type OnePayload struct {
|
||
Data *Node `json:"data"`
|
||
Included []*Node `json:"included,omitempty"`
|
||
Links *Links `json:"links,omitempty"`
|
||
}
|
||
|
||
// ManyPayload is used to represent a generic JSON API payload where many
|
||
// resources (Nodes) were included in an [] in the "data" key
|
||
type ManyPayload struct {
|
||
Data []*Node `json:"data"`
|
||
Included []*Node `json:"included,omitempty"`
|
||
Links *Links `json:"links,omitempty"`
|
||
}
|
||
|
||
// Node is used to represent a generic JSON API Resource
|
||
type Node struct {
|
||
Type string `json:"type"`
|
||
ID string `json:"id"`
|
||
ClientID string `json:"client-id,omitempty"`
|
||
Attributes map[string]interface{} `json:"attributes,omitempty"`
|
||
Relationships map[string]interface{} `json:"relationships,omitempty"`
|
||
Links *Links `json:"links,omitempty"`
|
||
}
|
||
|
||
// RelationshipOneNode is used to represent a generic has one JSON API relation
|
||
type RelationshipOneNode struct {
|
||
Data *Node `json:"data"`
|
||
Links *Links `json:"links,omitempty"`
|
||
}
|
||
|
||
// RelationshipManyNode is used to represent a generic has many JSON API
|
||
// relation
|
||
type RelationshipManyNode struct {
|
||
Data []*Node `json:"data"`
|
||
Links *Links `json:"links,omitempty"`
|
||
}
|
||
|
||
// Links is used to represent a `links` object.
|
||
// http://jsonapi.org/format/#document-links
|
||
type Links map[string]interface{}
|
||
|
||
func (l *Links) validate() (err error) {
|
||
// Each member of a links object is a “link”. A link MUST be represented as
|
||
// either:
|
||
// - a string containing the link’s URL.
|
||
// - an object (“link object”) which can contain the following members:
|
||
// - href: a string containing the link’s URL.
|
||
// - meta: a meta object containing non-standard meta-information about the
|
||
// link.
|
||
for k, v := range *l {
|
||
_, isString := v.(string)
|
||
_, isLink := v.(Link)
|
||
|
||
if !(isString || isLink) {
|
||
return fmt.Errorf(
|
||
"The %s member of the links object was not a string or link object",
|
||
k,
|
||
)
|
||
}
|
||
}
|
||
return
|
||
}
|
||
|
||
// Link is used to represent a member of the `links` object.
|
||
type Link struct {
|
||
Href string `json:"href"`
|
||
Meta map[string]interface{} `json:"meta,omitempty"`
|
||
}
|
||
|
||
// Linkable is used to include document links in response data
|
||
// e.g. {"self": "http://example.com/posts/1"}
|
||
type Linkable interface {
|
||
JSONAPILinks() *Links
|
||
}
|
||
|
||
// RelationshipLinkable is used to include relationship links in response data
|
||
// e.g. {"related": "http://example.com/posts/1/comments"}
|
||
type RelationshipLinkable interface {
|
||
// JSONAPIRelationshipLinks will be invoked for each relationship with the corresponding relation name (e.g. `comments`)
|
||
JSONAPIRelationshipLinks(relation string) *Links
|
||
}
|