ldproxy

Foundation

specstableimplmature

Essenzielle Funktionalität, API-Katalog mit allen veröffentlichten APIs.

Umfang

Konfiguration

Stellt Basis-Funktionalität für alle anderen Bausteine bereit und kann daher nicht deaktiviert werden.

Optionen

NameDefaultBeschreibungTypSeit
buildingBlock
Immer FOUNDATION.
string
v2.0
enabled
true
Soll der Baustein aktiviert werden?
boolean
v2.0
useLangParameter
false
Steuert, ob die Sprache der Antwort bei allen GET-Operationen nur über den Accept-Lang-Header oder auch über einen Parameter lang ausgewählt werden kann.
boolean
v2.0
includeLinkHeader
true
Steuert, ob die in Antworten der API enthaltenen Links auch als HTTP-Headeropen in new window zurückgegeben werden.
boolean
v2.0
apiCatalogLabel
API Overview
Titel für die API-Catalog-Ressource in diesem Deployment.
string
v2.0
apiCatalogDescription
The following OGC Web APIs are available.
Beschreibung für die API-Catalog-Ressource in diesem Deployment. HTML-Markup wird bei der HTML-Ausgabe aufbereitet.
string
v2.0
apiCatalogAdditionalEntries
[]
Zusätzliche Einträge für die API-Catalog-Ressource in diesem Deployment. Jeder Eintrag muss eine id, einen title und eine landingPageUri enthalten. Optional können auch eine description und eine Liste von tags angegeben werden. Einträge, die keinen Datensatz darstellen, sollten isDataset auf false setzen.
array
v2.0
googleSiteVerification
null
Sofern gesetzt, wird der Wert in die HTML-Seite des API-Catalog-Ressource in einem "googleSiteVerification"-Meta-Tag eingebettet (<meta name="google-site-verification`" content="{value}" >).
string
v2.0
includeSpecificationInformation
false
Steuert, ob Informationen (Name, Link, Reifegrad) über die Spezifikation einer API-Komponente, z.B. eine Operation oder ein Query-Parameter, in die API-Definition aufgenommen werden. Es wird empfohlen, diese Option zu aktivieren, wenn die API Bausteine enthält, die nicht als stable gekennzeichnet sind.
boolean
v2.0

Beispiele

Das Schema der API-Catalog-Ressource ist:


type: object
required:
  - apis
properties:
  title:
    type: string
  description:
    type: string
  apis:
    type: array
    items:
      type: object
      required:
        - title
        - landingPageUri
      properties:
        title:
          type: string
        description:
          type: string
        landingPageUri:
          type: string
          format: uri

Example of the specifications in the configuration file:

Beispiel für die Angaben in der Konfigurationsdatei:


- buildingBlock: FOUNDATION
  includeLinkHeader: true
  useLangParameter: false
  apiCatalogLabel: 'Demonstration APIs using ldproxy'
  apiCatalogDescription: 'The APIs below are available as examples for Web APIs that can be set up with <a href="https://github.com/interactive-instruments/ldproxy" >ldproxy</a>.'
ImpressumDatenschutzerklärung