From 2b86c5f382b36bf8fe35e833620a9ac5187e88e4 Mon Sep 17 00:00:00 2001 From: Elias <github@northernsi.de> Date: Sat, 26 Nov 2022 15:54:05 +0100 Subject: [PATCH 1/2] Fix some markdown issues :D Fixes the `Why:` block to be displayed as a code block --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 811817b..2c94de3 100644 --- a/README.md +++ b/README.md @@ -562,8 +562,8 @@ Having a good guideline for creating commits and sticking to it makes working wi - Produce readable production logging. Ideally use logging libraries to be used in production mode (such as [winston](https://github.com/winstonjs/winston) or [node-bunyan](https://github.com/trentm/node-bunyan)). - _Why:_ - > It makes your troubleshooting less unpleasant with colorization, timestamps, log to a file in addition to the console or even logging to a file that rotates daily. [read more...](https://blog.risingstack.com/node-js-logging-tutorial/) + _Why:_ + > It makes your troubleshooting less unpleasant with colorization, timestamps, log to a file in addition to the console or even logging to a file that rotates daily. [read more...](https://blog.risingstack.com/node-js-logging-tutorial/) <a name="api"></a> From f27f44826d120aa6b0aaac8c3e47ab3d93d5b60a Mon Sep 17 00:00:00 2001 From: Elias <github@northernsi.de> Date: Sat, 26 Nov 2022 15:55:44 +0100 Subject: [PATCH 2/2] Fix more issues! :D --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2c94de3..7d43236 100644 --- a/README.md +++ b/README.md @@ -742,27 +742,27 @@ _Why:_ - Use these status codes to send with your response to describe whether **everything worked**, The **client app did something wrong** or The **API did something wrong**. - _Which ones:_ - > `200 OK` response represents success for `GET`, `PUT` or `POST` requests. + _Which ones:_ + > `200 OK` response represents success for `GET`, `PUT` or `POST` requests. - > `201 Created` for when a new instance is created. Creating a new instance, using `POST` method returns `201` status code. + > `201 Created` for when a new instance is created. Creating a new instance, using `POST` method returns `201` status code. - > `204 No Content` response represents success but there is no content to be sent in the response. Use it when `DELETE` operation succeeds. + > `204 No Content` response represents success but there is no content to be sent in the response. Use it when `DELETE` operation succeeds. - > `304 Not Modified` response is to minimize information transfer when the recipient already has cached representations. + > `304 Not Modified` response is to minimize information transfer when the recipient already has cached representations. - > `400 Bad Request` for when the request was not processed, as the server could not understand what the client is asking for. + > `400 Bad Request` for when the request was not processed, as the server could not understand what the client is asking for. - > `401 Unauthorized` for when the request lacks valid credentials and it should re-request with the required credentials. + > `401 Unauthorized` for when the request lacks valid credentials and it should re-request with the required credentials. - > `403 Forbidden` means the server understood the request but refuses to authorize it. + > `403 Forbidden` means the server understood the request but refuses to authorize it. - > `404 Not Found` indicates that the requested resource was not found. + > `404 Not Found` indicates that the requested resource was not found. - > `500 Internal Server Error` indicates that the request is valid, but the server could not fulfill it due to some unexpected condition. + > `500 Internal Server Error` indicates that the request is valid, but the server could not fulfill it due to some unexpected condition. - _Why:_ - > Most API providers use a small subset HTTP status codes. For example, the Google GData API uses only 10 status codes, Netflix uses 9, and Digg, only 8. Of course, these responses contain a body with additional information. There are over 70 HTTP status codes. However, most developers don't have all 70 memorized. So if you choose status codes that are not very common you will force application developers away from building their apps and over to wikipedia to figure out what you're trying to tell them. [read more...](https://apigee.com/about/blog/technology/restful-api-design-what-about-errors) + _Why:_ + > Most API providers use a small subset HTTP status codes. For example, the Google GData API uses only 10 status codes, Netflix uses 9, and Digg, only 8. Of course, these responses contain a body with additional information. There are over 70 HTTP status codes. However, most developers don't have all 70 memorized. So if you choose status codes that are not very common you will force application developers away from building their apps and over to wikipedia to figure out what you're trying to tell them. [read more...](https://apigee.com/about/blog/technology/restful-api-design-what-about-errors) - Provide total numbers of resources in your response. - Accept `limit` and `offset` parameters.