REST API Design

Dieser Beitrag ist eine Begriffserklärung zum Thema REST API Design – inklusive Prüfungsfragen, Kernkomponenten und Tags.

In a Nutshell

REST ist ein Architekturstil für Web-Services, der ressourcenorientiertes Design und HTTP-Methoden nutzt, um skalierbare Schnittstellen zu schaffen.

Kompakte Fachbeschreibung

REST (Representational State Transfer) basiert auf sechs Constraints (u.a. Client-Server-Trennung, zustandslose Kommunikation). Ressourcen werden über URIs adressiert und über Repräsentationen (JSON/XML) übertragen. HTTP-Methoden (GET, POST, PUT, DELETE) bilden CRUD-Operationen ab. HATEOAS kann APIs „navigierbar“ machen. Performance wird u.a. durch Caching und Pagination optimiert.

Prüfungsrelevante Stichpunkte

• Richardson Maturity Model zur Bewertung der API-Qualität
• Idempotenz von PUT vs. POST
• HATEOAS als Hypermedia-Prinzip
• Sicherheit durch OAuth 2.0 und HTTPS
• Versionierung über URI oder Header

Kernkomponenten

1. Ressourcen (URI-Design)
2. HTTP-Methoden (GET, POST, PUT, DELETE)
3. Statuscodes (200, 201, 400, 401, 404, 500)
4. Medienformate (JSON, XML)
5. Sicherheitsmechanismen (HTTPS, OAuth)

Praxisbeispiel (Benutzerverwaltungs-API)

Ressourcen:
/users
/users/{id}

GET /users?page=1
POST /users
PUT /users/{id}
DELETE /users/{id}

Vor- und Nachteile

Vorteile	Nachteile
Einfache Integration	Komplexe Fehlerbehandlung
Wiederverwendbarkeit	Ohne Doku schwer nutzbar
Skalierbarkeit	Overfetching bei großen Ressourcen

Top Prüfungsfragen (mit Kurzantwort)

1. Welche HTTP-Methode ist idempotent aber nicht sicher? PUT.
2. Wie verhindert man Overfetching? Durch spezifische Abfrageparameter (oder alternative Ansätze wie GraphQL).
3. Drei Sicherheitsrisiken bei REST APIs? Broken Authentication, Mass Assignment, Injection.
4. Was bedeutet HATEOAS? Hypermedia As The Engine Of Application State – Links steuern Navigation.
5. Wie dokumentierst du REST APIs? Mit OpenAPI (Swagger).

Glossar

Begriff	Definition
Idempotenz	Mehrfache Ausführung hat gleiche Wirkung wie einmal
HATEOAS	Hypermedia-basierte Navigation zwischen Ressourcen
OAuth 2.0	Autorisierungsframework für delegierten Zugriff

Themenanalyse

• Technischer Kern: HTTP-Protokoll, Ressourcenmodellierung
• Implementierungsherausforderungen: konsistentes URI-Design, Fehlerhandling
• Sicherheitsimplikationen: Authentifizierung, Verschlüsselung
• Dokumentationspflichten: OpenAPI-Spezifikation
• Wirtschaftliche Bewertung: Wiederverwendung reduziert Entwicklungskosten

Lernstrategie

1. Verständniseinstieg: Analysiere eine bekannte API (z.B. GitHub REST API).
2. Vertiefungsmethode: Schreibe eine kleine OpenAPI-Spezifikation (Adressbuch).
3. Prüfungsfokustraining: Designe eine Produkt-API in 15 Minuten.
4. Fehlervermeidung: Prüfe Security mit OWASP ZAP.

Wichtigste Quellen

1. https://swagger.io/specification/
2. https://owasp.org/www-project-api-security/
3. https://docs.github.com/rest
4. https://www.postman.com/api-examples/