API-Schema-Validierung ist der Prozess der Überprüfung, ob eingehende API-Anfragen und ausgehende API-Antworten einer vordefinierten Struktur (Schema) entsprechen. Dieses Schema beschreibt das erwartete Datenformat, Datentypen, erforderliche Felder, Längenbeschränkungen und andere Regeln für die API-Nutzung. Sie ist eine fundamentale Sicherheitspraxis.
📜
Was definiert ein API-Schema?
•
Endpunkte und Operationen: Welche Pfade und HTTP-Methoden sind verfügbar?
•
Parameter: Welche Query-, Path-, Header- oder Cookie-Parameter werden erwartet?
•
Request Body: Wie muss der Anforderungs-Body strukturiert sein (z.B. JSON- oder XML-Struktur)?
•
Response Body: Wie ist der Antwort-Body strukturiert?
•
Datentypen: Welche Datentypen haben die einzelnen Felder (String, Integer, Boolean, Array, Object)?
•
Erforderliche Felder: Welche Felder müssen in der Anfrage/Antwort vorhanden sein?
•
Einschränkungen: Längenbegrenzungen für Strings, Wertebereiche für Zahlen, erlaubte Werte (Enums), Muster (Regex) für Strings.
•
Formate: Spezifische Formate wie Datum, Uhrzeit, E-Mail, UUID.
⚙
️ Wie funktioniert die Validierung?
•
Schema-Definition: Das erwartete Format wird formal definiert, typischerweise mithilfe von Standards wie: - **OpenAPI Specification (OAS):** Für RESTful APIs (Version 2.0 hieß Swagger).