server

type Config ¶

type Config struct {
	// contains filtered or unexported fields
}

func DefaultConfig() Config

func (c *Config) Apply(options ...Options)

func (c *Config) ApplyWriteOptions(options ...WriteOptions)

type DocumentOptions ¶

type DocumentOptions = func(http.ResponseWriter, *jsonapi.Document) error

type Handler ¶

type Handler struct {
	Config // Configuration options for the handler.
	// contains filtered or unexported fields
}

Handler wraps an http handler, providing JSON:API context to downstream consumers.

By default, Handler determines context from the request url:

":base/:type"                        // for resource type
":base/:type/:id"                    // for resource type and resource id
":base/:type/:id/relationships/:ref" // for resource type, id, and relationship name
":base/:type/:id/:ref"               // for type, id, relationship, and if the request is for related resources.

This behavior and others can be modified via configuration Options. Handler implements http.Handler and can be used anywhere http handlers are accepted.

Handler zero values are not initialized; use the Handle function to create a new instance.

func Handle(handler http.Handler, options ...Options) Handler

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

type Middleware ¶

type Middleware = func(next http.Handler) http.Handler

type Options ¶

type Options func(*Config)

func WithContextResolver(resolver jsonapi.RequestContextResolver) Options

func WithMiddleware(middleware Middleware) Options

type Relationship ¶

type Relationship struct {
	GetRef    http.Handler // GetRef handles requests to fetch a specific resource relationship.
	UpdateRef http.Handler // UpdateRef handles requests to update a specific resource relationship.
	AddRef    http.Handler // AddRef handles requests to add a specific resource relationship.
	RemoveRef http.Handler // RemoveRef handles requests to remove a specific resource relationship.
}

Relationship handlers route requests that correspond to a resource's relationships. Supported requests include GetRef, UpdateRef, AddRef, and RemoveRef. If the request does not match the JSON:API specifications for the above handlers, a 404 error is returned to the client

Relationship instances can be used alone or as a handler to a Resource instance's Ref field.

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

type RelationshipMux ¶

type RelationshipMux map[string]http.Handler

RelationshipMux is a http handler multiplexer for a resource's relationships. Each handler within the mux corresponds to a specific relationship, indexed the relationship name. If the relationship is not defined, a 404 error is returned to the client.

RelationshipMux must be wrapped by or have a parent handler wrapped by Handle to provide JSON:API request context.

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

type Resource ¶

type Resource struct {
	Refs   http.Handler // Refs handles requests to resource relationships.
	Create http.Handler // Create handles requests to create new resources.
	List   http.Handler // List handles requests to list resource collections.
	Get    http.Handler // Get handles requests to fetch a specific resource.
	Update http.Handler // Update handles requests to update a specific resource.
	Delete http.Handler // Delete handles requests to delete a specific resource.
}

Resource is a collection of handlers for resource endpoints. Each handler corresponds to a specific JSON:API resource operation, such as Create, List, Get, Update, etc. The request type is determined by the HTTP method and the JSON:API context. Resource instances are intended to be used in conjunction with ResourceMux.

Resource must be wrapped by or have a parent handler wrapped by Handle to provide JSON:API request context.

The handler members are optional. If the corresponding request handler is nil, the request is rejected with a 404 Not Found response.

If the request method does not conform to the JSON:API specification, the request is rejected with a 405 Method Not Allowed response.

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

type ResourceMux ¶

type ResourceMux map[string]http.Handler

ResourceMux is similar to http.ServeMux, but instead of routing requests directly from URL patterns, routes are determined by JSON:API context resource type. Add resource handlers explicitly or via the ResourceMux's Handle() method. When an incoming request is received, and the JSON:API request context is resolved, the handler that resolves the request will be determined by the request context's resource type. Undefined resource requests will return 404 responses.

ResourceMux must have be wrapped by or have a parent handler wrapped by Handle to provide JSON:API request context.

func (m ResourceMux) Handle(resource string, handler http.Handler)

func (m ResourceMux) ServeHTTP(w http.ResponseWriter, r *http.Request)

type ResponseRecorder ¶

type ResponseRecorder struct {
	Status        int               // The response status code.
	HeaderMap     http.Header       // The response headers.
	Document      *jsonapi.Document // The response document payload.
	JSONUnmarshal jsonUnmarshalFunc // A function that unmarshals JSON documents. Defaults to [json.Unmarshal].
	JSONMarshal   jsonMarshalFunc   // A function that marshals JSON documents. Defaults to [json.Marshal].
}

ResponseRecorder rr implements http.ResponseWriter, capturing WriteHeader() and Write() calls into its instance members. To send recorded data to a response writer w, call rr.Flush(w).

The zero value of ResponseRecorder is uninitialized; use the NewRecorder() function to create a new instance.

func NewRecorder() *ResponseRecorder

func (ww ResponseRecorder) Flush(w http.ResponseWriter)

func (ww *ResponseRecorder) Header() http.Header

func (ww *ResponseRecorder) Write(p []byte) (int, error)

func (ww *ResponseRecorder) WriteHeader(status int)

type WriteOptions ¶

type WriteOptions func(*Config)

func WithDocumentOptions(options DocumentOptions) WriteOptions

func WithJSONMarshaler(marshal jsonMarshalFunc) WriteOptions

func WriteLink(key string, href string) WriteOptions

func WriteLocationHeader(baseURL string, resolver jsonapi.URLResolver) WriteOptions

func WriteMeta(key string, value any) WriteOptions

func WriteNavigationLinks(r *http.Request, info map[string]query.Page) WriteOptions

func WriteRef(name string) WriteOptions

func WriteResourceLinks(baseURL string, resolver jsonapi.URLResolver) WriteOptions

func WriteSelfLink(r *http.Request) WriteOptions

func WriteSortedPrimaryData(cmp jsonapi.Comparator, criterion []query.Sort) WriteOptions