Class: QgsServerOgcApiHandler

class qgis.server.QgsServerOgcApiHandler

Bases: sip.wrapper

The QgsServerOgcApiHandler abstract class represents a OGC API handler to be registered in QgsServerOgcApi class.

Subclasses must override operational and informative methods and define the core functionality in handleRequest() method.

The following methods MUST be implemented: - path - operationId - summary (shorter text) - description (longer text) - linkTitle - linkType - schema

Optionally, override: - tags - parameters - contentTypes - defaultContentType

New in version 3.10: Enums

Methods

contentTypeForAccept

Looks for the first ContentType match in the accept header and returns its mime type, returns an empty string if there are not matches.

contentTypeFromRequest

Returns the content type from the request.

contentTypes

Returns the list of content types this handler can serve, default to JSON and HTML.

defaultContentType

Returns the default response content type in case the client did not specifically ask for any particular content type.

description

Description

handleRequest

Handles the request within its context

href

Returns an URL to self, to be used for links to the current resources and as a base for constructing links to sub-resources

layerFromCollection

Returns a vector layer from the collectionId in the given context

linkTitle

Title for the handler link

linkType

Main role for the resource link

operationId

Returns the operation id for template file names and other internal references

parameters

Returns a list of query string parameters.

parentLink

Returns a link to the parent page up to levels in the HTML hierarchy from the given url, MAP query argument is preserved

path

URL pattern for this handler, named capture group are automatically extracted and returned by values()

staticPath

Returns the absolute path to the base directory where static resources for this handler are stored in the given context.

summary

Summary

tags

Tags

templatePath

Returns the HTML template path for the handler in the given context

values

Analyzes the incoming request context and returns the validated parameter map, throws QgsServerApiBadRequestError in case of errors.

write

Writes data to the context response stream, content-type is calculated from the context request, optional htmlMetadata for the HTML templates can be specified and will be added as “metadata” to the HTML template variables.

Signals

Attributes

contentTypeForAccept(self, accept: str) → str

Looks for the first ContentType match in the accept header and returns its mime type, returns an empty string if there are not matches.

contentTypeFromRequest(self, request: QgsServerRequest) → QgsServerOgcApi.ContentType

Returns the content type from the request.

The path file extension is examined first and checked for known mime types, the “Accept” HTTP header is examined next. Fallback to the default content type of the handler if none of the above matches.

Raises

QgsServerApiBadRequestError – if the content type of the request is not compatible with the handler (contentTypes() member)

contentTypes(self) → List[QgsServerOgcApi.ContentType]

Returns the list of content types this handler can serve, default to JSON and HTML. In case a specialized type (such as GEOJSON) is supported, the generic type (such as JSON) should not be listed.

defaultContentType(self) → QgsServerOgcApi.ContentType

Returns the default response content type in case the client did not specifically ask for any particular content type.

description(self) → object

Description

handleRequest(self, context: QgsServerApiContext)

Handles the request within its context

Subclasses must implement this methods, and call validate() to extract validated parameters from the request.

Raises

QgsServerApiBadRequestError – if the method encounters any error

href(self, context: QgsServerApiContext, extraPath: str = '', extension: str = '') → object

Returns an URL to self, to be used for links to the current resources and as a base for constructing links to sub-resources

Parameters
  • context – the current request context

  • extraPath – an optional extra path that will be appended to the calculated URL

  • extension – optional file extension to add (the dot will be added automatically).

layerFromCollection(context: QgsServerApiContext, collectionId: str) → QgsVectorLayer

Returns a vector layer from the collectionId in the given context

linkTitle(self) → object

Title for the handler link

linkType(self) → QgsServerOgcApi.Rel

Main role for the resource link

operationId(self) → object

Returns the operation id for template file names and other internal references

parameters(self, context: QgsServerApiContext) → List[QgsServerQueryStringParameter]

Returns a list of query string parameters.

Depending on the handler, it may be dynamic (per-request) or static.

Parameters

context – the request context

Returns a link to the parent page up to levels in the HTML hierarchy from the given url, MAP query argument is preserved

path(self) → QRegularExpression

URL pattern for this handler, named capture group are automatically extracted and returned by values()

Example: “/handlername/(?P<code1>d{2})/items” will capture “code1” as a named parameter.

See also

values()

staticPath(self, context: QgsServerApiContext) → str

Returns the absolute path to the base directory where static resources for this handler are stored in the given context.

summary(self) → object

Summary

tags(self) → List[str]

Tags

templatePath(self, context: QgsServerApiContext) → str

Returns the HTML template path for the handler in the given context

The template path is calculated from QgsServerSettings’s apiResourcesDirectory() as follow: apiResourcesDirectory() + “/ogc/templates/” + context.apiRootPath + operationId + “.html” e.g. for an API with root path “/wfs3” and an handler with operationId “collectionItems”, the path will be apiResourcesDirectory() + “/ogc/templates/wfs3/collectionItems.html”

values(self, context: QgsServerApiContext) → Dict[str, Any]

Analyzes the incoming request context and returns the validated parameter map, throws QgsServerApiBadRequestError in case of errors.

Path fragments from the named groups in the path() regular expression are also added to the map.

Your handleRequest method should call this function to retrieve the parameters map.

Returns

the validated parameters map by extracting captured named parameters from the path (no validation is performed on the type because the regular expression can do it), and the query string parameters.

See also

path()

See also

parameters()

Raises

QgsServerApiBadRequestError – if validation fails

write(self, data: Any, context: QgsServerApiContext, htmlMetadata: Dict[str, Any] = {})

Writes data to the context response stream, content-type is calculated from the context request, optional htmlMetadata for the HTML templates can be specified and will be added as “metadata” to the HTML template variables.

HTML output uses a template engine.

Available template functions: See: https://github.com/pantor/inja#tutorial

Available custom template functions: - path_append( path ): appends a directory path to the current url - path_chomp( n ): removes the specified number “n” of directory components from the current url path - json_dump(): prints current JSON data passed to the template - static( path): returns the full URL to the specified static path, for example: static(“/style/black.css”) will return something like “/wfs3/static/style/black.css”. - links_filter( links, key, value ): returns filtered links from a link list - content_type_name( content_type ): returns a short name from a content type for example “text/html” will return “HTML”