OpenAPI Spezifikation
Maschinenlesbare API-Definition für automatisierte Tooling-Integration
OpenAPI 3.1 Standard
OpenAPI Spezifikation v1.0
Vollständige API-Definition im YAML-Format mit allen Endpunkten, Schemas und Authentifizierungsmethoden.
Warum OpenAPI?
Die OpenAPI Spezifikation ist weit mehr als nur Dokumentation. Sie ist eine maschinenlesbare Quelle der Wahrheit für Ihre API-Integration, die zahlreiche Automatisierungsmöglichkeiten eröffnet:
SDK-Generierung
Generieren Sie automatisch typisierte Client-Bibliotheken für TypeScript, Python, Java, Go und 50+ weitere Sprachen.
Request-Validierung
Validieren Sie API-Requests und Responses automatisch gegen die Spezifikation - vor dem Deployment.
Mock-Server
Erstellen Sie Mock-Server für lokales Testen, bevor die Backend-Integration abgeschlossen ist.
Contract Testing
Stellen Sie sicher, dass Client und Server sich auf das gleiche API-Verhalten einigen.
SDK-Generierung
Mit OpenAPI Generator können Sie vollständig typisierte Client-SDKs in wenigen Sekunden erstellen. Folgen Sie diesen Anleitungen für Ihre bevorzugte Programmiersprache:
TypeScript / Node.js
Generieren Sie ein typsicheres TypeScript-SDK mit automatischer Typerkennung:
Installation & Generierung
# OpenAPI Generator installieren
npm install -g @openapitools/openapi-generator-cli
# TypeScript SDK generieren
openapi-generator-cli generate \
-i steuermappe-api-v1.yaml \
-g typescript-axios \
-o ./src/api-client \
--additional-properties=supportsES6=true,npmName=@yourorg/steuermappe-client
# SDK verwenden
cd ./src/api-client && npm install && npm run buildVerwendungsbeispiel:
TypeScript Client Beispiel
import { Configuration, BatchesApi } from '@yourorg/steuermappe-client';
const config = new Configuration({
basePath: 'https://api.steuermappe-pro.de/v1',
accessToken: 'your-oauth-token'
});
const batchesApi = new BatchesApi(config);
// Typsicherer API-Aufruf
const batch = await batchesApi.createBatch({
projectId: 'proj_123',
documents: files,
mandantId: 'mand_456' // Optional
});
console.log(`Batch erstellt: ${batch.data.id}`);Python
Erstellen Sie ein Pythonisches SDK mit Type Hints und Pydantic-Validierung:
Python SDK Generierung
# OpenAPI Generator mit Docker (empfohlen)
docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli generate \
-i /local/steuermappe-api-v1.yaml \
-g python \
-o /local/python-client \
--additional-properties=packageName=steuermappe_client,projectName=steuermappe-client
# Oder mit pip
pip install openapi-generator-cli
openapi-generator-cli generate -i steuermappe-api-v1.yaml -g python -o ./python-client
# SDK installieren
cd python-client && pip install .Python Client Beispiel
from steuermappe_client import ApiClient, Configuration, BatchesApi
from steuermappe_client.models import CreateBatchRequest
# Konfiguration
config = Configuration(
host="https://api.steuermappe-pro.de/v1",
access_token="your-oauth-token"
)
# API-Client erstellen
with ApiClient(config) as api_client:
batches_api = BatchesApi(api_client)
# Batch erstellen (mit Type Hints)
request = CreateBatchRequest(
project_id="proj_123",
documents=files,
mandant_id="mand_456" # Optional
)
batch = batches_api.create_batch(request)
print(f"Batch erstellt: {batch.id}")Java / Spring
Generieren Sie ein Java-SDK mit Spring RestTemplate oder WebClient-Support:
Java SDK Generierung
# Java SDK mit Maven-Build generieren
openapi-generator-cli generate \
-i steuermappe-api-v1.yaml \
-g java \
-o ./java-client \
--additional-properties=\
library=resttemplate,\
groupId=com.yourorg,\
artifactId=steuermappe-client,\
apiPackage=com.yourorg.steuermappe.api,\
modelPackage=com.yourorg.steuermappe.model
# Build
cd java-client && mvn clean installJava Client Beispiel
import com.yourorg.steuermappe.api.BatchesApi;
import com.yourorg.steuermappe.model.CreateBatchRequest;
import com.yourorg.steuermappe.model.Batch;
// API-Client konfigurieren
ApiClient apiClient = new ApiClient();
apiClient.setBasePath("https://api.steuermappe-pro.de/v1");
apiClient.setAccessToken("your-oauth-token");
BatchesApi batchesApi = new BatchesApi(apiClient);
// Batch erstellen
CreateBatchRequest request = new CreateBatchRequest()
.projectId("proj_123")
.documents(files)
.mandantId("mand_456"); // Optional
Batch batch = batchesApi.createBatch(request);
System.out.println("Batch erstellt: " + batch.getId());Weitere Sprachen verfügbar
Empfohlene Tools
Nutzen Sie diese bewährten Tools für API-Entwicklung und -Testing:
Postman
Importieren Sie die OpenAPI-Spezifikation direkt in Postman für interaktive API-Exploration, automatisierte Tests und Team-Kollaboration.
Swagger UI
Kostenlose, Open-Source-Lösung für interaktive API-Dokumentation. Testen Sie API-Endpunkte direkt im Browser mit vollständiger OAuth2-Unterstützung.
Insomnia
Moderne REST-Client-Alternative mit nativer OpenAPI-Unterstützung, GraphQL-Integration und eleganter Benutzeroberfläche.
Stoplight Studio
Visueller OpenAPI-Editor mit Live-Vorschau, Validierung und Versionskontrolle. Ideal für API-Design-First-Workflows.
Interaktiver API-Explorer
Testen Sie die API direkt im Browser
Unser interaktiver API-Explorer basiert auf Swagger UI und ermöglicht Ihnen, jeden Endpunkt live zu testen - ohne Code schreiben zu müssen.
API-Explorer öffnenChangelog & Versionierung
Die SteuerMappePro API folgt semantischer Versionierung (SemVer). Breaking Changes werden mindestens 6 Monate im Voraus angekündigt.
Initiales Release
- Batches API mit Multipart-Upload
- OAuth2 Client Credentials Flow
- Webhook-Benachrichtigungen
- Partner-Code-Rabatte
- DSGVO-konforme Datenverwaltung
Kommende Features
- Batch-Vorlagen für wiederkehrende Workflows
- Erweiterte Webhook-Filter
- Batch-Archivierung und -Export
Benachrichtigungen über API-Updates
Spezifikationsdetails
| OpenAPI Version | 3.1.0 |
| API Version | v1.0.0 |
| Basis-URL | https://api.steuermappe-pro.de/v1 |
| Authentifizierung | OAuth2 (Client Credentials) |
| Content Types | application/json, multipart/form-data |
| Letzte Aktualisierung | 15. Januar 2025 |
Nächste Schritte
Haben Sie Fragen zur Integration?
Unser Entwickler-Support hilft Ihnen bei SDK-Generierung, Tooling-Setup und technischen Fragen.