QGIS API Documentation 3.41.0-Master (d5b93354e9c)
|
Server generic API endpoint abstract base class. More...
#include <qgsserverapi.h>
Public Member Functions | |
QgsServerApi (QgsServerInterface *serverIface) | |
Creates a QgsServerApi object. | |
virtual | ~QgsServerApi ()=default |
virtual bool | accept (const QUrl &url) const |
Returns true if the given url is handled by the API, default implementation checks for the presence of rootPath inside the url path. | |
virtual const QString | description () const =0 |
Returns the API description. | |
virtual void | executeRequest (const QgsServerApiContext &context) const =0 |
Executes a request by passing the given context to the API handlers. | |
virtual const QString | name () const =0 |
Returns the API name. | |
virtual const QString | rootPath () const =0 |
Returns the root path for the API. | |
QgsServerInterface * | serverIface () const |
Returns the server interface. | |
virtual const QString | version () const |
Returns the version of the service. | |
Server generic API endpoint abstract base class.
An API must have a name and a (possibly empty) version and define a (possibly empty) root path (e.g. "/wfs3").
The server routing logic will check incoming request URLs by passing them to the API's accept(url) method, the default implementation performs a simple check for the presence of the API's root path string in the URL. This simple logic implies that APIs must be registered in reverse order from the most specific to the most generic: given two APIs with root paths '/wfs' and '/wfs3', '/wfs3' must be registered first or it will be shadowed by '/wfs'. APIs developers are encouraged to implement a more robust accept(url) logic by making sure that their APIs accept only URLs they can actually handle, if they do, the APIs registration order becomes irrelevant.
After the API has been registered to the server API registry:
the incoming calls with an URL path starting with the API root path will be routed to the first matching API and executeRequest() method of the API will be invoked.
Definition at line 80 of file qgsserverapi.h.
QgsServerApi::QgsServerApi | ( | QgsServerInterface * | serverIface | ) |
Creates a QgsServerApi object.
Definition at line 24 of file qgsserverapi.cpp.
|
virtualdefault |
|
virtual |
Returns true
if the given url is handled by the API, default implementation checks for the presence of rootPath inside the url path.
Definition at line 29 of file qgsserverapi.cpp.
|
pure virtual |
Returns the API description.
Implemented in QgsServerOgcApi.
|
pure virtual |
Executes a request by passing the given context to the API handlers.
Implemented in QgsServerOgcApi.
|
pure virtual |
Returns the API name.
Implemented in QgsServerOgcApi.
|
pure virtual |
Returns the root path for the API.
Implemented in QgsServerOgcApi.
QgsServerInterface * QgsServerApi::serverIface | ( | ) | const |
Returns the server interface.
Definition at line 34 of file qgsserverapi.cpp.
|
inlinevirtual |
Returns the version of the service.
Reimplemented in QgsServerOgcApi.
Definition at line 106 of file qgsserverapi.h.