REST-API-Framework. Empfohlene Verhalten für ungültig querystring-parameter

Ich die Umsetzung einer REST-API-Framework, und ich Frage mich, was die recommendedbehavior ist, wenn ein client sendet eine ungültige querystring-parameter.

Werde ich veranschaulichen, was ich meine mit einem konkreten Beispiel:
Sagen, ich haben eine API-handler auf die /api/contacts/Endpunkt, und der handler stellt einen querystring-filter mit dem Namen id, die es dem Kunden ermöglicht, wählen Sie bestimmten Kontakten mit den zur Verfügung gestellten IDs.

So, einen GET-oder DELETE-Anforderung könnte /api/contacts/?id=2&id=4&id=lalalala.

Klar, es gibt keine solche Sache wie ein Kontakt mit id=lalalala. In diesem Fall, was sollte der server sich so Verhalten?

  • Ignorieren die ungültigen Kontakt mit id=lalalala, und nur filtern Sie die Kontakte auf die gültigen ids, 2 und 4.

  • Antwortet mit einem Fehler-code, der angibt, dieser Fehler. Wenn ja, welcher Fehler-code sollte zur Verfügung gestellt werden?

Vielen Dank im Voraus.

Edit: um Zu klären, wobei Der Schwerpunkt auf der Rahmen, den ich zu entwickeln, ist ein vorhersehbares Verhalten, und damit response-codes. Aus diesem Grund möchte ich die clients verbrauchen eine API basierend auf diesem framework, zu erwarten, die geringsten überraschungen.
Also, die Frage ist grundsätzlich: Soll die API einen Fehler zurückgeben, in diesem Fall(und wenn ja, welche)? Oder ignorieren Sie ungültige Einträge filtern, und filter nur auf den richtigen querystring-Parameter?

InformationsquelleAutor Charalambos Paschalides | 2012-03-27
  1. 13

    Da dies ein REST-Aufruf sprechen wir über die Ressourcen. Und wenn wir einen falschen filter, wir sollten wieder zurück, eine richtige Fehler-code.

    In diesem Fall würde ich für 400 - bad request wie die Ressource wurde gefunden und richtig zugeordnet (/api/contacts), aber es gab ein problem mit der query string Teil. Daher 400 und nicht ein 404.

    Zurückkehren würde eine 404 wenn jemand angefordert /api/contacts-all oder einige nicht-existente Ressource.

    BEARBEITEN basierend auf den Kommentaren unten

    Stimmen zu Ihrem Kommentar. Idealerweise ein 400 ist ein problem mit der Anfrage. Danach könnte man eine 422 Unprocessable Entity. Bitte schauen Sie auf der stackoverflow-link unten, und er spricht über die gleiche Sache.

    Ich würde vermuten, dass Entwickler auf der ganzen Welt angenehmer wäre zu sehen, eine 400 als 422 für solche logischen Fehler aufgrund der Tatsache, dass größere Unternehmen sind mit 400 und nicht 422.

    Referenzen:
    Http-status-codes und
    400 für logische Fehler vs ungültige Anfrage

    • Ravi, vielen Dank für die Antwort. Ich bin damit einverstanden, dass Sie einen 400 Fehler macht eine Menge Sinn. Das einzige, was hält mich davon ab, das zu tun, ist, dass ich wieder 400-Fehler, wenn ungültige Daten enthalten sind, die in den request-body (zum Beispiel bei PUT/POST-Anfragen), und es scheint ein wenig counter-intuitive, aber noch vertretbaren, was die gleiche Reaktion in diesem Fall.
    • Haben Sie einen Blick auf das bearbeitete Antwort oben.
    • Ravi, vielen Dank. Sehr vollständige und klare Antwort. 422 Fehler zu sein scheint, die richtige Antwort, da die Anfrage ist semantisch falsch. Ich werde es studieren mehr gründlich und erhalten zurück zu Ihnen bald.
    • 422 unprocessable entity, aber das problem hier ist ein query-parameter, die nicht Teil der Entität. Ich denke, 404 ist am besten.
    InformationsquelleAutor Ravi Bhatt
  2. 10

    Nach den Buchstaben des Gesetzes, die Antwort sollte ein 404 not found. Jedoch, niemand wird dich zu sehr aufgeregt mit, wenn Sie lieber zurückgeben 400 - bad request.

    Ich würde auf jeden Fall zurück ein 4XX-Statuscode obwohl. Sie möchten, dass der client wissen, dass Sie einen Fehler gemacht.

    • Darrel, danke für die Antwort. Ich würde mit Ihnen einverstanden, obwohl, die Antwort sollte einen 404 error, da die API-Endpunkt zu korrigieren, und Karten auf eine gültige Ressource (zB. /api/contacts/). Einen 400-Fehler würde mehr Sinn machen, nehme ich an 🙂
    • Darrel, Sie haben definitiv einen Punkt hier. Als Sie zunächst sagte, obwohl, obwohl nach den Buchstaben des Gesetzes die Antwort hätte ein 404-Fehler, ich bin Neigung mehr in Richtung auf einen 400-Fehler.
    InformationsquelleAutor Darrel Miller
Schreibe einen Kommentar