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

Follow principles of good REST design in API #75

Open
mvsjober opened this issue Nov 8, 2016 · 2 comments
Open

Follow principles of good REST design in API #75

mvsjober opened this issue Nov 8, 2016 · 2 comments
Assignees

Comments

@mvsjober
Copy link
Member

mvsjober commented Nov 8, 2016

https://codeplanet.io/principles-good-restful-api-design/

For example use POST for adding new item, and PUT for updating existing one. Right now POST are used for both.

Standardise to plural form for endpoints. E.g. POST /profiles, GET /profiles/{id}

@mvsjober mvsjober self-assigned this Nov 8, 2016
@mvsjober
Copy link
Member Author

For the new Profile API I have tried to follow these. Updating the other APIs will break compatibility unless we implement a versioning mechanism.

@mvsjober
Copy link
Member Author

One option is to put the refactored API under e.g. /api/v2 or similar, and keep the old one at /api for some time.

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