jsonapi

package

v0.8.1 Latest Latest Go to latest Published: Mar 8, 2020 License: Apache-2.0 Imports: 28 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/neuronlabs/gateway

Documentation ¶

Index ¶

Constants
func AcceptMediaTypeMid(next httprouter.Handle) httprouter.Handle
func New(c *controller.Controller, cfg *config.Router, router ...*httprouter.Router) handler.Handler
func UnsupportedMediaTypeMid(next httprouter.Handle) httprouter.Handle
type Handler

Constants ¶

View Source

const (
	// HeaderAcceptLanguage is the HTTP header name for accepted languages.
	HeaderAcceptLanguage = "Accept-Language"
	// HeaderContentLanguage is the HTTP header name for the content language.
	HeaderContentLanguage = "Content-Language"
)

View Source

const (
	// QueryParamPageTotal is the query parameter that marks to get total number instances / pages for the collection.
	QueryParamPageTotal string = "page[total]"
	// QueryParamLinks is the query parameter that marks to marshal object links.
	QueryParamLinks string = "links"
)

Variables ¶

This section is empty.

Functions ¶

func AcceptMediaTypeMid ¶

func AcceptMediaTypeMid(next httprouter.Handle) httprouter.Handle

AcceptMediaTypeMid is the middleware that checks if the request contains Header "Accept: application/vnd.api+json".

func New ¶

func New(c *controller.Controller, cfg *config.Router, router ...*httprouter.Router) handler.Handler

New creates new jsonapi Handler.

func UnsupportedMediaTypeMid ¶

func UnsupportedMediaTypeMid(next httprouter.Handle) httprouter.Handle

UnsupportedMediaTypeMid is the middleware that checks if the request contains Header "Content-Type" with media type different then `application/vnd.api+json`

Types ¶

type Handler ¶

type Handler struct {
	Config *config.Router
	// contains filtered or unexported fields
}

Handler is the neuron gateway handler that implements https://jsonapi.org server routes for neuron models.

func (*Handler) Router ¶

func (h *Handler) Router() *httprouter.Router

Router implements handler.Handler interface.

func (*Handler) SetModelRoutes ¶

func (h *Handler) SetModelRoutes(model interface{}) error

SetModelRoutes sets the routes for the provided 'model'. The model must be registered within the controller provided in the Handler creator. Implements router.Router interface.

func (*Handler) SetRoutes ¶

func (h *Handler) SetRoutes() (err error)

SetRoutes sets the JSONAPI specific routes for all model registered within the Handler's controller. Implements router.Router interface.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL