REST API Standards (Include Best practices for Methods, Headers, Versioning, Naming convention etc) #6
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
anishmanandhar
commented
Jun 22, 2020
anishmanandhar
commented
anishmanandhar
added
the
documentation
anishmanandhar
requested review from
RobusGauli,
bipenc,
kabirbaidhya,
mesaugat,
neetin,
pratishshr,
sagarlf and
taarimalta
pratishshr
reviewed
Jun 22, 2020
|
|
||
| #### The following convention should be followed for REST API Headers | ||
|
|
||
| * Headers names should be **noun** and should be **Captialised-Case** separated by **(-)**. e.g **Token-Key**, **Account-ID**, **Tenant-ID** etc |
Contributor
There was a problem hiding this comment.
Suggested change
| * Headers names should be **noun** and should be **Captialised-Case** separated by **(-)**. e.g **Token-Key**, **Account-ID**, **Tenant-ID** etc | |
| * Headers names should be **noun** and should be **Capitalised-Case** separated by **(-)**. e.g **Token-Key**, **Account-ID**, **Tenant-ID** etc |
|
|
||
| * Never expose information on URLs. <https://api.app.com/users/{id}/fetch?apiKey=abcd123456789> //Bad practice | ||
|
|
||
| * Conside using token based authentication like OAUTH2 |
Contributor
There was a problem hiding this comment.
Suggested change
| * Conside using token based authentication like OAUTH2 | |
| * Consider using token based authentication like OAUTH2 |
…rds-convention into rest-api # Conflicts: # sidebars.js
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.