---
title: OpenAPI-Beispiel
description: Sehen Sie eine live generierte OpenAPI-Endpoint-Seite und erfahren Sie, wie Jamdesk Anfragen, Antworten und Authentifizierung aus Ihrer Spezifikation rendert.
openapi: /openapi/example-api.yaml POST /tickets
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

Diese Seite zeigt einen live aus einer [OpenAPI-Spezifikation](https://spec.openapis.org/oas/latest.html) generierten Endpoint. Das Anfrage-Schema, die Antwortmodelle und die Codebeispiele im rechten Bereich werden vollständig automatisch aus der Spezifikation generiert, ohne dass eine manuelle Erstellung erforderlich ist.

<Info>
Dieses Beispiel verwendet die Acme Support API. Aktualisieren Sie `api.openapi` in Ihrer `docs.json`, sodass die Datei Ihrer eigenen Spezifikation verwendet wird und echte Endpoints generiert werden.
</Info>

<Info>
**Mehrsprachige Dokumentation?** Legen Sie neben Ihrer Quellspezifikation eine Datei im Format `<spec>.<lang>.<ext>` (z. B. `example-api.fr.yaml`) ab. Jamdesk rendert die übersetzte Version, wenn Benutzer die Seite unter `/fr/...` aufrufen. Weitere Informationen finden Sie unter [OpenAPI-Spezifikationen übersetzen](/de/setup/languages#übersetzen-von-openapi-spezifikationen).
</Info>

<Tip>
Auf dieser Seite ist das [API Playground](/de/api-reference/playground) aktiviert. Klicken Sie beim obigen Endpoint auf **Try it**, um die API live zu testen.
</Tip>

## Was wird generiert?

Aus einer einzigen `openapi`-Zeile im Frontmatter generiert Jamdesk automatisch:

- Ein Endpoint-Badge mit Methode und Pfad sowie farblicher Kennzeichnung
- Parameterdokumentation für Pfad-, Query-, Header- und Body-Parameter
- Anfrage- und Antwort-Schemas, einschließlich verschachtelter Objekte und Arrays
- Codebeispiele in cURL, Python, JavaScript, Go, Ruby, C#, Java, Rust und PHP (konfigurierbar über `api.examples.languages`)
- Authentifizierungsdetails aus den Sicherheitsschemata der Spezifikation

Alle `$ref`-Referenzen in Ihrer Spezifikation werden automatisch aufgelöst, sodass Sie Schemas wie gewohnt mit `components/schemas` organisieren können.

## OpenAPI einrichten

Legen Sie Ihre OpenAPI-3.x-Spezifikation (YAML oder JSON) im Verzeichnis `openapi/` ab, registrieren Sie sie in `docs.json` unter `api.openapi` und fügen Sie anschließend `openapi: /openapi/your-spec.yaml METHOD /path` zum Frontmatter einer beliebigen Seite hinzu. Eine vollständige Anleitung finden Sie im [Leitfaden zur OpenAPI-Einrichtung](/de/setup/directory-structure#openapi).

<Tip>
  Schreiben Sie Ihre Spezifikation in YAML? Überprüfen Sie sie mit dem kostenlosen [YAML Validator](https://jamdesk.com/utilities/yaml-validator), um Einrückungs- und Syntaxfehler zu erkennen, bevor der Build sie verarbeitet.
</Tip>

## Verwandte Seiten

<Columns cols={2}>
  <Card title="API Playground" icon="flask-vial" href="/de/api-reference/playground">
    Interaktives API-Testen auf Ihren Endpoint-Seiten aktivieren
  </Card>
  <Card title="Anfrage-/Antwortbeispiele" icon="code" href="/de/api-reference/request-response-examples">
    Von Hand erstelltes Endpoint-Beispiel mit MDX-Komponenten
  </Card>
</Columns>

<Columns cols={2}>
  <Card title="OpenAPI-Einrichtung" icon="file-code" href="/de/setup/directory-structure#openapi">
    Speicherort und Referenzierung von OpenAPI-Dateien
  </Card>
  <Card title="docs.json-Referenz" icon="file-lines" href="/de/config/docs-json-reference">
    Vollständige Konfigurationsreferenz einschließlich api.openapi
  </Card>
</Columns>

---

📦 **OpenAPI specs:** Every OpenAPI specification referenced by this documentation is available as a single download — https://jamdesk-docs.jamdesk.app/api-specs.zip