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.

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

Implement more best practices for the API #128

Open
mrchrmn opened this issue Jan 10, 2022 · 1 comment
Open

Implement more best practices for the API #128

mrchrmn opened this issue Jan 10, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@mrchrmn
Copy link
Member

mrchrmn commented Jan 10, 2022

following the suggestions outlined in this article:
https://blog.devgenius.io/best-practice-and-cheat-sheet-for-rest-api-design-6a6e12dfa89f
@mrchrmn mrchrmn added the enhancement New feature or request label Jan 10, 2022
@medic-code
Copy link
Contributor

A small win might be versioning the API, so that if there are breaking changes, large API updates and can ensure backward compatability in the future.

Worth a discussion on what would constitute a change in API version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mrchrmn @medic-code