Haufe-Lexware / api-style-guide

Haufe API Style Guide

Home Page:https://haufe-lexware.gitbooks.io/haufe-api-styleguide/content/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Proposal: Add a section for valid and invalide url patterns

gabiBrysch opened this issue · comments

within Aka-I we discussed valid and invalid url patterns regarding collection resources and query parameters, we decided this way p.e. collection for users

  • to retrieve a list both urls, with and without trailing slash is valid: /users and /users/
  • to retrieve a list filtered with further query params, only the variant /users?offset= is valid, not the variant with the combination "/?" /users/?offset= in it, because the "?" gets interpreted as a further (id) value.

I added it to the uri components, I will inform you when I published it.