Eine Methode aufrufen
POST oder GET, Body oder Query-String, und was der Feldvalidator erwartet.
Ein Methodenname ist Teil der URL. Jede andere Eingabe, auch eine ID, ist ein Parameter: ein JSON-Body-Feld
bei POST, ein Query-String-Parameter bei GET. Beide Formen erreichen dieselbe Methode und liefern
dieselbe Hülle.
POST: ein JSON-Body
Die normale Form für alles mit mehr als ein paar Parametern oder mit einem verschachtelten Objekt oder Array.
GET: ein Query-String
Praktisch für einen schnellen Test aus der Adressleiste des Browsers oder per curl-Einzeiler. Der Server
parst den Query-String in denselben Body, den der Methoden-Handler sieht, deshalb sind die folgenden Regeln
hier wichtiger als bei POST.
Der deklarierte Typ eines Felds bestimmt, wie sein Query-String-Wert gelesen wird:
- string: wird unverändert verwendet.
- number: wird durch
Number(...)geschickt. - boolean: Nur der literale String
truewird alstruegelesen. Alles andere, das du beiGETfür ein boolean-Feld übergibst, auchfalse, wird zu einer wahren1umgewandelt. Wenn ein boolean wichtig ist, sende ihn perPOSTmit einem echten JSON-true/false, oder lass den Query-Parameter einfach weg, damit die Voreinstellung der Methode gilt. - object / array: Der Wert wird durch
JSON.parse(...)geschickt, ein verschachtelter Wert muss beiGETalso ein Query-Parameter sein, der einen JSON-String enthält (filters=%7B%22status%22%3A%22open%22%7D), keine Query-Verschachtelung im Klammerstil.
Pflichtfelder und Typfehler
Jedes Feld einer Methode trägt ein Flag mandatory und einen type. Fehlt ein Pflichtfeld oder sendest du
bei POST (wo nichts automatisch umgewandelt wird) den falschen Typ, bekommst du ein -1 zurück, bevor die
Methode selbst überhaupt läuft:
Die interaktive API-Referenz listet die Felder jeder Methode mit Typen und Pflicht-Flags auf und lässt dich einen Aufruf im Browser ausführen, um die exakte Anfrage zu sehen, die er gebaut hat.