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.

Sign up for GitHub

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

Jump to bottom

suggestion: REST Best Practices #4

Open

dwmkerr opened this issue Apr 25, 2021 · 0 comments

dwmkerr commented Apr 25, 2021

📚 Handbook

I have to educate people on this again and again. Things like:

Naming of routes, spinal case vs camel case
Plural/Singular routes
Status Codes
Common patterns (e.g. query strings for optional searching fields)
LImit/number of results, paging

Some useful reading:

https://blog.restcase.com/5-basic-rest-api-design-guidelines/

For ages I've been wanting to write the 'definitive' guide to REST APIs, I'd be very happy to take this one on.

tobiasbueschel changed the title ~~Suggestion: REST Best Practices~~ suggestion: REST Best Practices

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment