REST API Namenskonventionen

eine Diskussion in der Arbeit zu haben, bemerkte ich einige APIs wie unten eine Syntax ausgeführt werden:REST API Namenskonventionen

/webapi/messaging/getMessage?messageID=n (HTTP GET)

In meinen Augen ist dies eine schlechte Praxis, tho einige Kollegen zu widersprechen scheinen. In meinen Augen sollte das etwas in Richtung

sein

/webapi/messaging/messages/n (HTTP GET)

Ich bin ein Anfänger hier, sind beide dieser Beispiele ausreichend? Wenn einer besser ist, warum ist es besser? Meine Argumentation ergibt sich aus den Dingen, die ich während des Lernens aufgefangen habe, die trotzdem schlechte Informationen sein könnten.

Dank

Quelle

2017-04-03 symon

Ihr Weg ist besser, einfach weil es die häufiger verwendete Konvention folgt. –

ist es auch sicher zu sagen, dass es besser ist, das Unbekannte zu berücksichtigen? Wenn zum Beispiel in diesem Szenario keine Möglichkeit zum Löschen einer Nachricht mit Konvention B vorhanden wäre, könnten wir einfach HTTP DELETE zum selben Verzeichnis von/webapi/messaging/message/n hinzufügen. das andere Szenario würde in diesem Szenario nicht zu viel Sinn ergeben oder deleteMessage? id = n erfordern – symon

Es sollte nicht wirklich wichtig sein. REST gibt an, dass URLs über Links wie Links auf normalen Webseiten erkennbar sein müssen.

Eine konsistente, selbsterklärende URL-Struktur wäre jedoch immer die bessere Option. Daher ist Ihr die bessere Möglichkeit, die Namenskonventionen für REST-APIs zu verwenden.

/webapi/messaging/message/n (HTTP GET)

Reference

Quelle

2017-04-03 11:34:24

REST API Namenskonventionen

Antwort

Verwandte Themen