OpenAPI 3.0 und 3.1 Beispiele als YAML und JSON

OpenAPI ist ein Standardformat, um HTTP-Schnittstellen maschinenlesbar zu beschreiben, wahlweise als YAML oder JSON. Die Seite zeigt die kleinste Beschreibung in Version 3.0.3 als Text, als Datei und als JSON, einen Pfad mit Parameter, ein Bearer-Sicherheitsschema und einen Kopf in Version 3.1 mit webhooks.

6 Varianten auf einer Seite, jede mit eigenem Kopier- oder Download-Knopf. Darunter: 2× Reservierter Bereich.

OpenAPI 3.0: kleinste Beschreibung (YAML)Reservierter Bereich
```
openapi: 3.0.3
info:
  title: Beispiel-API …
```
Pflichtfelder openapi, info (title, version), paths; Beispiel mit Schema-Verweis.
OpenAPI 3.0: kleinste Beschreibung (Datei openapi.yaml)Reservierter Bereich
```
openapi: 3.0.3
info:
  title: Beispiel-API …
```
Dieselbe Idee als Datei, ohne Schema.
OpenAPI 3.0: kleinste Beschreibung (JSON)
```
{
  "openapi": "3.0.3",
  "info": { …
```
Kleinstmöglich mit einem Pfad.
OpenAPI 3.0: Pfad mit Parameter
```
paths:
  /kunden/{id}:
    get: …
```
Pfadparameter müssen required: true sein.
OpenAPI 3.0: Bearer-Authentifizierung
```
components:
  securitySchemes:
    bearerAuth: …
```
Globales Sicherheitsschema.
OpenAPI 3.1: Kopf mit Webhook
```
openapi: 3.1.0
info:
  title: Beispiel-API …
```
Ab 3.1 gibt es das Feld webhooks und paths ist optional.

OpenAPI 3.0 und 3.1 Beispiele als YAML und JSON

OpenAPI 3.0: kleinste Beschreibung (YAML)Reservierter Bereich

OpenAPI 3.0: kleinste Beschreibung (Datei openapi.yaml)Reservierter Bereich

OpenAPI 3.0: kleinste Beschreibung (JSON)

OpenAPI 3.0: Pfad mit Parameter

OpenAPI 3.0: Bearer-Authentifizierung

OpenAPI 3.1: Kopf mit Webhook

Weitere Themen in Web & API