Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pluralize endpoint name(s) #3

Open
booo opened this issue Dec 8, 2013 · 0 comments
Open

pluralize endpoint name(s) #3

booo opened this issue Dec 8, 2013 · 0 comments

Comments

@booo
Copy link

booo commented Dec 8, 2013

Just skimmed the api documentation [1] and I think you should puralize? the endpoint name for router to api/routers. If there are or will be other endpoints you should also rename them.

A maybe good resource for arguments:

http://www.vinaysahni.com/best-practices-for-a-pragmatic-restful-api

Maybe it's also worth to think about the routers_by_location resource? Just brain storming:

  • api/bboxes/1/2/3/4 (-1)
  • api/routers?bbox=1,2,3,4 (+1)
  • api/routers?clustered=true
  • api/routers?clustered=true&stripped=true

I understand that this is a very subjective topic but there are some conventions that most people try to follow and maybe we should try to do so too.

Thanks for your ongoing hard work on the topic! Nice work!!!

Best Regards
Philipp

[1] https://github.com/libremap/libremap-api/blob/master/doc-api.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant