> ## Documentation Index
> Fetch the complete documentation index at: https://developers.jobhandy.io/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAPI-Spezifikation

> Laden Sie den maßgeblichen Vertrag der JobHandy Public API im OpenAPI-3.1-JSON- oder YAML-Format herunter.

<Badge color="purple" shape="pill" icon="braces">OpenAPI 3.1.0</Badge> <Badge color="green" shape="pill" icon="circle-check">Produktionsvertrag</Badge>

Beide Dateien beschreiben dieselbe Public API und verwenden den produktiven Server `https://api.jobhandy.io/v1`.

<Columns cols={2}>
  <Card title="JSON herunterladen" icon="braces" href="https://assets.jobhandy.io/api-spec/jobhandy-public-api.openapi.json" arrow="true">
    Maschinenlesbarer OpenAPI-3.1-Vertrag im JSON-Format.
  </Card>

  <Card title="YAML herunterladen" icon="file-code" href="https://assets.jobhandy.io/api-spec/jobhandy-public-api.openapi.yaml" arrow="true">
    Semantisch gleichwertiger OpenAPI-3.1-Vertrag im YAML-Format.
  </Card>
</Columns>

## Vertragsprofil

| Eigenschaft        | Wert                         |
| ------------------ | ---------------------------- |
| OpenAPI-Version    | `3.1.0`                      |
| API-Version        | `1.0.0`                      |
| Produktiver Server | `https://api.jobhandy.io/v1` |
| Pfade              | `15`                         |
| Operationen        | `21`                         |
| Component-Schemas  | `25`                         |
| Authentifizierung  | API-Key in `X-API-Key`       |

<Warning>
  Die aktuelle Version `1.0.0` enthält aktualisierte Schemas für `Order`, `OrderHrHistory`, `OrderProduct` und die Divisionsreihenfolge. Prüfen Sie den [Changelog](/de/operations/changelog) und aktualisieren Sie die betroffenen Client-Modelle vor der Übernahme der aktualisierten Spezifikation.
</Warning>

## Empfohlene Verwendung

* typisierte Clients und Modelle erzeugen
* Endpoints in API-Testtools importieren
* Requests und Responses in CI validieren
* Vertragsversionen vor der Client-Übernahme vergleichen
* Contract Tests und Mocks erstellen
* die exakt übernommene Spezifikation mit jedem Client-Release archivieren

## Übernahmeablauf

```mermaid theme={"theme":{"light":"github-light","dark":"github-dark"}}
flowchart LR
    A[Spezifikation herunterladen] --> B[Validieren und Prüfsumme bilden]
    B --> C[Diff gegen übernommene Version]
    C --> D[Client erzeugen oder aktualisieren]
    D --> E[Contract Tests ausführen]
    E --> F[Kundenabnahmetests ausführen]
    F --> G[Übernommene Version dokumentieren]
```

<Card title="Tooling und Client-Generierung" icon="wrench" horizontal href="/de/operations/tooling-openapi">
  Importieren Sie den Vertrag, erzeugen Sie Clients und automatisieren Sie Kompatibilitätsprüfungen.
</Card>