{"id":15574059,"url":"https://github.com/michaelbazos/rest-cheatsheet","last_synced_at":"2025-04-19T10:56:29.265Z","repository":{"id":86308182,"uuid":"78034105","full_name":"michaelbazos/rest-cheatsheet","owner":"michaelbazos","description":null,"archived":false,"fork":false,"pushed_at":"2017-08-07T14:09:47.000Z","size":4,"stargazers_count":6,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-29T07:11:29.233Z","etag":null,"topics":["architecture","cheatsheet","readme","rest","rest-api"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/michaelbazos.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-01-04T16:44:59.000Z","updated_at":"2023-06-20T11:24:58.000Z","dependencies_parsed_at":"2023-03-13T09:42:21.049Z","dependency_job_id":null,"html_url":"https://github.com/michaelbazos/rest-cheatsheet","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelbazos%2Frest-cheatsheet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelbazos%2Frest-cheatsheet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelbazos%2Frest-cheatsheet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/michaelbazos%2Frest-cheatsheet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/michaelbazos","download_url":"https://codeload.github.com/michaelbazos/rest-cheatsheet/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249678694,"owners_count":21309796,"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","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":["architecture","cheatsheet","readme","rest","rest-api"],"created_at":"2024-10-02T18:15:17.729Z","updated_at":"2025-04-19T10:56:29.260Z","avatar_url":"https://github.com/michaelbazos.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/michaelbazos/rest-cheatsheet/stargazers\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/stars/michaelbazos/rest-cheatsheet.svg?style=flat-square\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\u003ch1 align=\"center\"\u003eRest Architecture Cheatsheet \u003c/h1\u003e\n\n## Definitions\n\nREST stands for _**RE**presentational **S**tate **T**ransfer_. The term was introduced in 2000, in Roy Thomas Fielding's dissertation [Architectural Styles and the Design of Network-based Software Architectures](http://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm).\n\n## Hey server, can I tell you something _please?_\n\nThe following table the expected meaning of requests in a restful API for typical use-cases:\n\n| Method | Path to a specific id, like `/printers/{id}` | Path to a collection, like `/printers` |\n| :---------: | :------------------------------: | :-----------------------------: |\n| GET | \"Please _get_ me the data for this printer\" | \"Please get me the data for the entire collection of printers\" |\n| PUT | \"Please _(over)write_ this printer with the object I have in body\" | \"Please _(over)write_ this collection of printers with the object I have in body\" |\n| POST | _Don't do it. You post specific items at the collection level_ | \"My body contains a printer object. Please add it to the collection. It'd nice if you get back to me with the resulting ID\" |\n| DELETE | \"Please delete this printer\" | \"Please delete the entire collection of printers\" |\n| PATCH | \"Please patch this printer object with the properties I'm sending you in body\" | _Not typically allowed_ |\n\n\n## References\n\n- **[RFC 7230](https://tools.ietf.org/html/rfc7230)** HTTP/1.1 Message Syntax and Routing\n- **[RFC 7231](https://tools.ietf.org/html/rfc7231)** HTTP/1.1 Semantics and Content\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelbazos%2Frest-cheatsheet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmichaelbazos%2Frest-cheatsheet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmichaelbazos%2Frest-cheatsheet/lists"}