Dokumentationsplattform (diese Seite)

1. Beschreibung

Dieser Inhalt kann OpenAPI-Spezifikation als Webseite darstellen. Der Daten aus einer *.yaml- oder *.json-Datei werden mit der Swagger-UI dargestellt.

2. Verwendung

<urn:openapi>
    <urn:name>Public API</urn:name>
    <urn:pfad>api/openapi_PublicServices.json</urn:pfad>
</urn:openapi>

3. Attribute

Die folgenden Attribute erweitern das Basis-Schema von Inhalt mit Link-spezifischen Informationen

Name(*=Pflichtfeld)DatentypDefaultBeschreibung

name*

String

-

Ein logischer Name für die OpenAPI-Definition

pfad*

String

-

Der Pfad zur OpenAPI-Definition, die mit der Swagger-UI dargestellt werden soll

TODO hier können wir ggf. noch das Inhaltsverzeichnis rechts darstellen?