ldproxy

Common Core

specstableimplmature

Gemeinsame Ressourcen aller OGC Web APIs.

Umfang

Konformitätsklassen

Common Core implementiert alle Vorgaben der Konformitätsklasse Core von OGC API - Features - Part 1: Core 1.0.1open in new window für die drei genannten Ressourcen.

Information

Die Konformitätsklasse wurde in ldproxy auf drei Bausteine aufgeteilt, da auch andere OGC API Standards bestimmte Teile wiederverwenden. Die Bausteine "Common Core" und "Feature Collections" bilden dies ab.

Operationen

RessourcePfadMethodenFormateBeschreibung
Landing Page
{@path}
GET
HTML, JSON, XML
Die Landing Page bietet Links zur API-Definition (Link-Relationen service-desc und service-doc), zur Konformitätserklärung (Pfad /conformance, Link-Relation conformance) und zu anderen Ressourcen in der API.
Conformance Declaration
conformance
GET
HTML, JSON, XML
Die URIs aller von der API unterstützten Konformitätsklassen. Diese Informationen werden bereitgestellt, um "generische" Clients zu unterstützen, die auf mehrere OGC-API-Implementierungen zugreifen wollen - und nicht "nur" auf eine bestimmte API. Für Clients, die nur auf eine einzige API zugreifen, ist diese Information im Allgemeinen nicht relevant und die OpenAPI-Definition beschreibt die API im Detail.
API Definition
api
GET
HTML, JSON, YAML
Stellt die OpenAPI-Definition bereit.

Query Parameter

NameRessourcenBeschreibung
f
Landing Page, Conformance Declaration
Wählt das Ausgabeformat der Antwort. Wenn kein Wert angegeben wird, gelten die Standard-HTTP Regeln, d.h. der "Accept"-Header wird zur Bestimmung des Formats verwendet.
f
API Definition
Wählt das Ausgabeformat der Antwort. Wenn kein Wert angegeben wird, gelten die Standard-HTTP Regeln, d.h. der "Accept"-Header wird zur Bestimmung des Formats verwendet.
lang
*
Wählt die Sprache der Antwort. Wenn kein Wert angegeben wird, gelten die Standard-HTTP Regeln, d.h. der "Accept-Language"-Header wird zur Bestimmung der Sprache verwendet.
token
*
Setzt das Autorisierungs-Token für die Anfrage. Wird kein Wert angegeben, gelten die Standard-HTTP-Regeln, d. h. der Autorisierungs-Header wird zur Bestimmung des Tokens verwendet.

Konfiguration

Optionen

NameDefaultBeschreibungTypSeit
buildingBlock
Immer COMMON.
string
v3.1
enabled
true
Soll der Baustein aktiviert werden?
boolean
v3.1
caching
{}
Setzt feste Werte für HTTP-Caching-Header für die Ressourcen.
object
v3.1
additionalLinks
[]
Erlaubt es, zusätzliche Links in der Landing Page zu ergänzen. Der Wert ist ein Array von Link-Objekten. Anzugeben sind jeweils mindestens die URI (href), der anzuzeigende Text (label) und die Link-Relation (rel).
array
v3.1

Beispiele


- buildingBlock: COMMON
  enabled: true
  caching:
    lastModified: '2021-07-01T00:00:00Z'
    expires: '2023-06-30T23:59:59Z'
    cacheControl: max-age=86400
    cacheControlItems: max-age=3600
  additionalLinks:
  - rel: describedby
    type: text/html
    title: Webseite mit weiteren Informationen
    href: 'https://example.com/pfad/zu/dokument'
    hreflang: de
ImpressumDatenschutzerklärung