API-Trigger konfigurieren
Geschrieben vonOssi Galkin Vor über einer Woche aktualisiertTable of contentsAPI-Trigger-Einstellungen
HTTP-Methode
Die HTTP-Methode ist an die in der OpenAPI-Spezifikation für den Vorgang definierte Methode gebunden und kann nur durch Ändern der OpenAPI-Spezifikation geändert werden. Gültige Werte sind GET, POST, PUT, DELETE, HEAD, OPTIONS und PATCH.
URL
Der URL-Pfad ist auf den für den Vorgang in der OpenAPI-Spezifikation definierten Wert festgelegt und kann nur durch Ändern der OpenAPI-Spezifikation geändert werden. Pfad- und Abfrageparameter sind zulässig.
Beispiel für Pfadparameter:
'/orders/{OrderID}': get: summary: Eine Bestellung mit ID abrufen Beschreibung: Gibt die Details der Bestellung zurück. Parameter: - Name: OrderID in: Pfad erforderlich: true Schema: Typ: ZeichenfolgeBeispiel für Pfadparameter in der API-Anfrage: GET /orders/4294
Wenn die Pfadparameter vom Typ „Integer“ oder „Boolean“ sind, wird der Pfad auf die Aufnahme dieser Typen beschränkt.
Dadurch können Endpunkte wie /api/pet/{id} und /api/pet/getStatus gleichzeitig und ohne Kollisionen aktiv sein, sofern der Parameter {id} vom Typ „Integer“ ist.
Beispiel für API-Anfragen mit Pfadparametern und mögliche Konflikte von Pfadparametern mit anderen API-Operationspfaden:
Beispiel einer API-Anforderung | Kommentare |
GET /api/pet/getStatus | Einfache API-Operation ohne Pfadparameter. Dieser Pfad muss beim Entwurf der anderen API-Operationen und ihrer Pfade berücksichtigt werden. |
GET /api/pet/324 | Diese ID funktioniert, der ID-Parameter /api/pet/{id} ist eine Ganzzahl, da Freunde die Anfrage immer mit der Operation /api/pet/{id} statt mit /api/pet/getStatus verknüpfen können. |
GET /api/pet/Muffet | Hier ist der ID-Parameter /api/pet/{id} ein String, aber das funktioniert nicht, weil die Möglichkeit bestünde, die Anfrage GET /api/pet/getStatus zu stellen, wenn Freunde nicht eindeutig erkennen können, ob die Anfrage für GET /api/pet/getStatus oder GET /api/pet/{id} bestimmt ist. |
Beispiel für Abfrageparameter:
/now: Beschreibung: Gibt das aktuelle Datum und die aktuelle Uhrzeit zurück. get: Parameter: - Name: Format in: Abfragebeschreibung: Format, in dem das aktuelle Datum/die aktuelle Uhrzeit zurückgegeben werden soll. Schema: Typ: Zeichenfolge
Beispiel für Abfrageparameter in der API-Anforderung: GET /now?Format=TT-MM-JJJJ
Erlaubte Protokolle
API-Trigger können so konfiguriert werden, dass sie Anfragen mit HTTP, HTTPS oder beiden akzeptieren. Wenn eine Anfrage mit einem nicht zulässigen Protokoll gestellt wird, lautet die Antwort „Verboten“ (403).
Es wird dringend empfohlen, immer HTTPS zu verwenden, da dies weitaus sicherer ist als HTTP.
Anfragen von diesen Ursprüngen zulassen (CORS)
Wenn es erforderlich ist, einer bestimmten Seite das Auslösen eines Prozesses zu erlauben, ist dies mit Cross-Origin Resource Sharing (CORS) möglich. Aktivieren Sie das Kontrollkästchen „Anfragen von diesen Ursprüngen zulassen“ und definieren Sie die zulässigen Ursprünge im Textfeld. Das Zeichen * erlaubt Aufrufe von allen Ursprüngen. Mehrere Ursprünge können durch ein Komma (,) oder Semikolon (;) getrennt angegeben werden.
Hinweis: Wenn der Anruf nicht vom Standardport kommt, muss er im Ursprung enthalten sein. Der Ursprung, der den Anruf tätigt, muss auch CORS unterstützen.
OpenAPI-Dokument
Eine schreibgeschützte Anzeige der an den Trigger gebundenen OpenAPI-Spezifikation.
Der nächste Artikel istEinführung in die Zwischenrendite
Verwandte ArtikelAPI-TriggerEinführung in API TriggerBeispiel zum Erstellen Ihrer ersten API-DefinitionEinführung in den Abschnitt „API-Pfade“Einführung in API Trigger