Class: QgsService

Defines interfaces for QGIS server services.

This class provides methods for executing server requests They are registered at runtime for a given service name.

Note

This is an abstract class, with methods which must be implemented by a subclass.

The following methods must be implemented: executeRequest(), name(), version()

Abstract Methods

executeRequest

Executes the requests and sets result in QgsServerRequest.

name

Returns the name of the service.

version

Returns the version of the service.

class qgis.server.QgsService[source]

Bases: object

abstract executeRequest(self, request: QgsServerRequest, response: QgsServerResponse, project: QgsProject | None)[source]

Executes the requests and sets result in QgsServerRequest.

Parameters:
abstract name(self) str[source]

Returns the name of the service.

Return type:

str

abstract version(self) str[source]

Returns the version of the service.

Return type:

str