The highest tagged major version is
Documentation
¶
Index ¶
- func UseFieldsetQueryParser(parser FieldsetQueryParser) server.Options
- func UseFilterQueryParser(parser FilterQueryParser) server.Options
- func UseIncludeQueryParser() server.Options
- func UseIncludedResourceResolver() server.Options
- func UsePaginationQueryParser(parser PageQueryParser) server.Options
- func UseRelatedResourceResolver() server.Options
- func UseRequestBodyParser() server.Options
- func UseSortQueryParser(parser SortQueryParser) server.Options
- type FieldsetQueryParser
- type FilterQueryParser
- type PageQueryParser
- type SortQueryParser
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func UseFieldsetQueryParser ¶
func UseFieldsetQueryParser(parser FieldsetQueryParser) server.Options
UseFieldsetQueryParser is a middleware that resolves the fieldset parameters from the request and stores them within the JSON:API request context.
func UseFilterQueryParser ¶
func UseFilterQueryParser(parser FilterQueryParser) server.Options
UseFilterQueryParser is a middleware that parses and extracts any filter parameters in the request query and generates a filter expression stored within the JSON:API request context.
func UseIncludeQueryParser ¶
UseIncludeQueryParser is a middleware that parses the list of included resources requested by the client and adds them to the JSON:API context.
func UseIncludedResourceResolver ¶
UseIncludedResourceResolver is a middleware that retrieves the client-request server resources associated with the response document's primary data, and adds it to the "included" array.
UseIncludedResourceResolver currently supports inclusion requests only one level deep; dot notation for multiple inclusions is not supported.
func UsePaginationQueryParser ¶
func UsePaginationQueryParser(parser PageQueryParser) server.Options
UsePaginationQueryParser is a middleware that parses the sort parameters from the URL query and stores them within the JSON:API context.
func UseRelatedResourceResolver ¶
UseRelatedResourceResolver is a middleware that handles incoming requests for related resources.
func UseRequestBodyParser ¶
func UseSortQueryParser ¶
func UseSortQueryParser(parser SortQueryParser) server.Options
UseSortQueryParser parses the sort parameters from the URL query and stores them within the JSON:API context.
Types ¶
type FieldsetQueryParser ¶
FieldsetQueryParser is a function that parses the fieldset query parameters.
type FilterQueryParser ¶
type FilterQueryParser interface {
// ParseFilterQuery parses the filter query parameter from the request.
ParseFilterQuery(*http.Request) (query.FilterExpression, error)
}
FilterQueryParser is a parser for JSON:API filter query parameters.
Source Files