REST-Endpunkt-Namen prüfen

Sie senden einen Pfad und erhalten ein strukturiertes Ergebnis: welche Konventionen erfüllt wurden, welche verletzt wurden und eine verständliche Meldung für jedes beanstandete Segment — so wird aus einem Review-Kommentar eine Korrektur statt einer Debatte.

Wie ein gut benannter Pfad aussieht

Die weithin akzeptierte Konvention lautet, dass jedes Pfadsegment ein Substantiv ist und Sammlungen den Plural verwenden: /users für die Sammlung, /users/{id} für ein einzelnes Element. Wörter innerhalb eines Segments werden mit Bindestrichen getrennt, im sogenannten kebab-case-Stil, weil Unterstriche in URLs schwerer lesbar sind und unter Link-Unterstreichungen verschwinden können, während camelCase Groß- und Kleinschreibung an eine Stelle mischt, an der Kleinschreibung die Norm ist. Versionspräfixe wie v1 oder v2 sind gängige Praxis und gelten nicht als Benennungsfehler.

Wenn ein Pfad diesen Regeln folgt, wird er vorhersehbar: Wer einen Endpunkt kennt, kann den Rest der Oberfläche erraten, ohne die Dokumentation zu lesen, und Werkzeuge wie Router, Gateways und Linter lassen sich einmal konfigurieren und für jeden Dienst des Teams wiederverwenden.

Was dieser Prüfer testet und wie er entscheidet

Der Prüfer zerlegt Ihren Pfad an den Schrägstrichen und ignoriert Query-String und Fragment, da diese nicht zur Ressourcenbenennung gehören. Jedes verbleibende Segment wird dann gegen vier Regeln getestet, und jeder Regelverstoß wird separat gemeldet, damit Sie genau sehen, welche Konvention ein Segment verletzt. Erstens Kleinbuchstaben: Jeder Großbuchstabe in einem Segment wird markiert, da die Schreibweise in Pfaden eine häufige Ursache für Routing-Fehler auf case-sensitiven Servern ist.

Zweitens Bindestriche: Unterstriche und Leerzeichen innerhalb eines Segments werden markiert, wobei Bindestriche als Ersatz genannt werden. Drittens Substantive im Plural: Segmente, die weder Versionspräfixe noch Pfadparameter sind, müssen auf ein pluralartig aussehendes Wort enden; ein Segment wie /user wird markiert, während /users besteht, und zusammengesetzte Segmente wie /user-profiles werden nach ihrem letzten Wort beurteilt. Viertens Verben: Jedes durch Bindestriche getrennte Wort wird mit einer festen Liste häufiger englischer Verben wie get, create, update, delete, fetch und login verglichen, und jeder Treffer wird markiert.

Pfadparameter in den Formen {id} oder :id sind von der Substantiv- und Verbenregel ausgenommen, weil ein Parametername anderen Konventionen folgt als ein statischer Ressourcenname.