{"id":20042617,"url":"https://github.com/code4mk/rest-api-tips","last_synced_at":"2026-02-16T16:05:37.283Z","repository":{"id":104452627,"uuid":"346312786","full_name":"code4mk/rest-api-tips","owner":"code4mk","description":"rest api tips and guideline","archived":false,"fork":false,"pushed_at":"2021-04-14T08:57:15.000Z","size":5,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-02T07:18:06.828Z","etag":null,"topics":["rest","rest-api"],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/code4mk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2021-03-10T10:11:46.000Z","updated_at":"2021-04-14T08:57:17.000Z","dependencies_parsed_at":null,"dependency_job_id":"45161b99-0d25-4c14-8974-1751b0528453","html_url":"https://github.com/code4mk/rest-api-tips","commit_stats":{"total_commits":4,"total_committers":2,"mean_commits":2.0,"dds":0.25,"last_synced_commit":"4d5453a18859624e53d3e2d03f3fecf7fe67aa61"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/code4mk/rest-api-tips","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code4mk%2Frest-api-tips","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code4mk%2Frest-api-tips/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code4mk%2Frest-api-tips/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code4mk%2Frest-api-tips/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/code4mk","download_url":"https://codeload.github.com/code4mk/rest-api-tips/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code4mk%2Frest-api-tips/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000776,"owners_count":26082851,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["rest","rest-api"],"created_at":"2024-11-13T10:52:30.767Z","updated_at":"2025-10-08T22:09:12.644Z","avatar_url":"https://github.com/code4mk.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# REST\n\nREST means representational state transfer.\n\n~ Separation of Client and Server.\n\n`Statelessness:` Systems that follow the REST paradigm are stateless, meaning that the server does not need to know anything about what state the client is in and vice versa.\n\n# API\n\nApplaciation Programming Interface. API allows two systems to communicate with one another.\n\n# key points\n\n* resource\n* collections\n* endpoint\n* response\n* http status\n\n# HTTP methods\n\n* get - (retrieve data)\n* post -  (submit post)\n* put - (replace all data)\n* patch - (partially update data)\n* delete - (delete data)\n\n~ resource\n* https://developer.mozilla.org/en-US/docs/Web/HTTP/Methods\n\n# Endpoint\n\nendpoint will be noun and plural form . endpoint will not verb.\n\nsegment will be dash as /holiday-schedules\n`{baseUrl}/v1/employees/holiday-schedules`\n\n# Header\n\nHTTP headers let the client and the server pass additional information with an HTTP request or response.\n\n```js\nAuthorization: 'Bearer Token'\nContent-Type: 'application/json'\nPublic-Key: ''\nSecret-Key: ''\n```\n\n~ resources\n* https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers\n\n# Status code\n\n## Success\n\n* 200 (ok) - retrieve data\n* 201 (created) - insert data\n* 204 (no content) - delete data\n\n## Cilent error\n\n* 400 (bad request)\n* 401 (unauthorize)\n* 403 (forbidden)\n* 404 (not found)\n* 405 (method not found)\n* 408 (request time out)\n* 414 (request get uri so long)\n* 429 (so many request)\n\n## server error\n\n* 500 (internal server error)\n* 503 (service not available)\n\n* https://httpstatuses.com/\n\n# summarize \n\n* endpoint (naming system,segment)\n* http methods\n* http status code \n\n~ feature \n* versioning\n* filtering,pagination,sorting\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode4mk%2Frest-api-tips","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcode4mk%2Frest-api-tips","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode4mk%2Frest-api-tips/lists"}