DBAPI: Wie führt man eine Parameterüberprüfung für API-Anfragen durch?

Praktische Umsetzung

Fall 1 – Überprüfung, dass die Länge eines Parameters nicht größer als 4 ist

• Klicken Sie im Projekt „Parameterüberprüfung“ auf „Neue Regel hinzufügen“.

• Geben Sie im Überprüfungs‑Skript den JavaScript‑Code ein, etwa name.length < 5. Tragen Sie anschließend die entsprechende Fehlermeldung ein; wird diese Regel nicht erfüllt, erscheint genau diese Fehlermeldung.

Hinweis: Der JavaScript‑Code kann mehrere Zeilen umfassen, solange die letzte Zeile einen booleschen Ausdruck oder eine boolesche Variable enthält und jede Zeile mit einem Semikolon endet. Beispiel: var res = name.length < 5; res;

Im Code können direkt die in der Anfrage definierten Parameternamen verwendet werden.

• Speichern Sie die API und veröffentlichen Sie sie.
• Rufen Sie die Seite zur API‑Anfragetestung auf, geben Sie einen längeren String ein und senden Sie die Anfrage. Daraufhin wird die entsprechende Fehlermeldung angezeigt.

Fall 2 – Mehrere Parameter überprüfen

• Wenn die API mehrere Parameter besitzt, kann jeder einzelne davon geprüft werden.

Klicken Sie einfach auf die Schaltfläche „Neu“, um beliebig viele Regeln zur Parameterüberprüfung hinzuzufügen.

Fall 3 – Zwischen mehreren Parametern prüfen

Fall 4 – Überprüfung komplexer verschachtelter JSON‑Parameter

• Auch bei APIs mit dem Content‑Type application/json sind Parameterüberprüfungen möglich.

Hinweis

• Diese Funktion ist ausschließlich in der Enterprise‑Edition verfügbar und wurde in DBAPI Enterprise Version 4.1.0 eingeführt.