Protokollmechanismen, die die themenbezogenen APIs nicht abdecken: 202 Accepted mit Job-Polling, 301/302 Weiterleitungen (und eine Kette), 503 mit Retry-After, ein garantierter 504, Accept-basierte Inhaltsverhandlung mit 406, HATEOAS-Links, RFC 6902 JSON Patch und 410 Gone.
Basis-URL: https://funapi.dev/api/protocol/v1 · 12 Endpunkte · OpenAPI-3.1-Spezifikation und Postman-Collection verfügbar. Neu hier? Lesen Sie die Einstiegsanleitung.
202 akzeptiert + Umfrage abgeschlossen
POST /protocol/v1/jobs — Einen asynchronen Job starten — 202 Akzeptiert · Antwortet mit 202 400 Link zu diesem EndpunktGET /protocol/v1/jobs/{id} — Umfrage zu einem Job – Fortschritte bei jeder Umfrage · Antwortet mit 200 404 Link zu diesem Endpunkt301, 302 und eine weitere Kette
GET /protocol/v1/moved/old-dashboard — Dauerhaft umgezogen — 301 · Antwortet mit 301 Link zu diesem EndpunktGET /protocol/v1/moved/new-dashboard — Wohin die 301 führt · Antwortet mit 200 Link zu diesem EndpunktGET /protocol/v1/hop — Eine 302-Weiterleitungskette – folgen Sie ihr nach unten · Antwortet mit 200 302 400 Link zu diesem Endpunkt503 & 504 auf Anfrage
GET /protocol/v1/maintenance — Geplante Wartungsarbeiten — 503 + Wiederholungsversuch · Antwortet mit 503 Link zu diesem EndpunktGET /protocol/v1/gateway-timeout — Langsame Upstream-Anfrage – wartet ca. 3 Sekunden, dann 504 · Antwortet mit 504 Link zu diesem EndpunktHATEOAS, JSON-Patch, 406 & 410
GET /protocol/v1/export/documents — Inhaltsverhandlung über Akzeptieren (406 bei allen anderen Optionen) · Antwortet mit 200 406 Link zu diesem EndpunktGET /protocol/v1/documents — Liste der Dokumente (HATEOAS-Links) · Antwortet mit 200 Link zu diesem EndpunktGET /protocol/v1/documents/{id} — Dokument abrufen (410 nach Löschung) · Antwortet mit 200 404 410 Link zu diesem EndpunktPATCH /protocol/v1/documents/{id} — RFC 6902 JSON-Patch (op/path/value) · Antwortet mit 200 400 404 409 Link zu diesem EndpunktDELETE /protocol/v1/documents/{id} — Dokument löschen (nur für Administratoren, dann 410) (erfordert Bearer-Auth) · Antwortet mit 204 401 403 404 410 Link zu diesem EndpunktDas Protocol Lab ist die Testumgebung für HTTP-Semantik im Katalog und deckt Bereiche ab, die die meisten simulierten APIs nicht abdecken: 202-akzeptierte asynchrone Prozesse, deren Abschluss durch regelmäßiges Abfragen überprüft wird, 301- und 302-Weiterleitungen, 503- und 504-Fehler, JSON-Patch und Inhaltsverhandlung, die mit 406 antwortet, wenn der Accept-Header nicht erfüllt werden kann. Wenn Sie eine Clientbibliothek überraschen soll, dann hier.
GET https://funapi.dev/api/protocol/v1/moved/old-dashboard — Dauerhaft umgezogen — 301. Kein Token, keine Anmeldung:
curl -i https://funapi.dev/api/protocol/v1/moved/old-dashboard
Antwort: 301 Moved Permanently
{
"error": "Moved Permanently",
"message": "The dashboard lives at /moved/new-dashboard now. Note that curl needs -L to follow redirects."
}
Diesen Endpunkt öffnen und ausführen
Zuletzt aktualisiert