Welche Vertragstypen werden bei der Erstellung einer REST-API angewendet?

Beim Erstellen einer REST-API werden folgende Vertragstypen verwendet:

• OpenAPI (Swagger) — Standard zur Beschreibung von REST-APIs, der die Dokumentation und Generierung von Client-Code ermöglicht.
• JSON Schema — definiert die Struktur der in Anfragen und Antworten verwendeten JSON-Objekte.
• gRPC (obwohl kein REST, wird manchmal als Vertrag für APIs verwendet) — Protokoll mit Vertrag basierend auf protobuf.

Im Kontext von REST-APIs wird hauptsächlich OpenAPI verwendet, das:

• Endpunkte (Pfade und HTTP-Methoden)
• Formate von Anfragen und Antworten
• Parameter und Header
• Antwortcodes

Beispiel für einen einfachen OpenAPI-Fragment:

paths:
  /users:
    get:
      summary: Liste der Benutzer abrufen
      responses:
        '200':
          description: Erfolgreiche Antwort
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/User'