jsonapi

Oct 15, 2019

Changes in this version

type Request

+ Original *http.Request

Nov 28, 2017

Changes in this version

type Intent

+ const CollectionAction

+ const ResourceAction

+ type Parser struct

+ CollectionActions map[string][]string

+ Prefix string

+ ResourceActions map[string][]string

+ func (p *Parser) ParseRequest(r *http.Request) (*Request, error)

type Request

+ CollectionAction string

+ ResourceAction string

Nov 15, 2017

Changes in this version

type Request

+ PageLimit int

+ PageOffset int

Dec 29, 2016

Changes in this version

type Request

+ func (r *Request) Base() string

Sep 12, 2016

Changes in this version

type Client

+ BaseURL string

+ Client *http.Client

Sep 12, 2016

Changes in this version

+ type Client struct

+ func NewClient(base string) *Client

+ func (c *Client) Request(req *Request, doc *Document) (*Document, error)

+ func (c *Client) RequestWithResource(req *Request, res *Resource) (*Document, error)

+ func (c *Client) RequestWithResources(req *Request, res []*Resource) (*Document, error)

Sep 12, 2016

Changes in this version

type Map

+ func (m Map) Assign(target interface{}) error

Sep 12, 2016

Changes in this version

type Error

+ func BadRequestPointer(detail, pointer string) *Error

type Map

+ func StructToMap(source interface{}, fields []string) Map

Sep 11, 2016

Changes in this version

type Document

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

type Intent

+ func (i Intent) RequestMethod() string

+ type Requester interface

+ Get func(key string) string

+ Method func() string

+ Path func() string

+ QueryParams func() map[string][]string

+ func BridgeRequest(r *http.Request) Requester

type Resource

+ func (r *Resource) AssignAttributes(target interface{}) error

+ type Responder interface

+ Set func(key, value string)

+ WriteHeader func(status int)

+ func BridgeResponseWriter(w http.ResponseWriter) Responder

Sep 10, 2016

Changes in this version

+ const MediaType

+ func MapToStruct(m interface{}, s interface{}, tagName ...string) error

+ func WriteError(res engine.Response, err error) error

+ func WriteErrorList(res engine.Response, errors ...*Error) error

+ func WriteResource(res engine.Response, status int, resource *Resource, links *DocumentLinks, ...) error

+ func WriteResources(res engine.Response, status int, resources []*Resource, links *DocumentLinks, ...) error

+ func WriteResponse(res engine.Response, status int, doc *Document) error

+ type Document struct

+ Data *HybridResource

+ Errors []*Error

+ Included []*Resource

+ Links *DocumentLinks

+ Meta Map

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

+ type DocumentLinks struct

+ First string

+ Last string

+ Next string

+ Previous string

+ Related string

+ Self string

+ type Error struct

+ Code string

+ Detail string

+ ID string

+ Links *ErrorLinks

+ Meta Map

+ Source *ErrorSource

+ Status int

+ Title string

+ func BadRequest(detail string) *Error

+ func BadRequestParam(detail, param string) *Error

+ func ErrorFromStatus(status int, detail string) *Error

+ func InternalServerError(detail string) *Error

+ func NotFound(detail string) *Error

+ func (e *Error) Error() string

+ type ErrorLinks struct

+ About string

+ type ErrorSource struct

+ Parameter string

+ Pointer string

+ type HybridResource struct

+ Many []*Resource

+ One *Resource

+ func (r *HybridResource) MarshalJSON() ([]byte, error)

+ func (r *HybridResource) UnmarshalJSON(doc []byte) error

+ type Intent int

+ const AppendToRelationship

+ const CreateResource

+ const DeleteResource

+ const FindResource

+ const GetRelatedResources

+ const GetRelationship

+ const ListResources

+ const RemoveFromRelationship

+ const SetRelationship

+ const UpdateResource

+ func (i Intent) DocumentExpected() bool

+ type Map map[string]interface

+ type Request struct

+ Fields map[string][]string

+ Filters map[string][]string

+ Include []string

+ Intent Intent

+ PageNumber int

+ PageSize int

+ Prefix string

+ RelatedResource string

+ Relationship string

+ ResourceID string

+ ResourceType string

+ Sorting []string

+ func ParseRequest(req engine.Request, prefix string) (*Request, error)

+ func (r *Request) Self() string

+ type Resource struct

+ Attributes interface{}

+ ID string

+ Meta Map

+ Relationships map[string]*Document

+ Type string