Download as PDF, PPTX
Uploaded byHossein Baghayi
REST, RESTful API
The document provides guidelines for designing RESTful APIs including using HTTP verbs for CRUD operations, plural nouns for resource collections, associating resources through nested URLs, parameterizing requests through query strings and headers, supporting pagination, versioning APIs through URI paths and headers, and returning error responses with status codes and messages. Key guidelines include designing resources as nouns, using consistent and intuitive URIs, and making APIs self-descriptive through hypermedia as the engine of application state.
More Related Content
Similar to REST, RESTful API
REST, RESTful API
- 1.
- 2.
- 3.
- 4. Make APIs Easyto Learn
- 5.
- 6.
- 7.
- 8.
- 9.
- 10.
- 11. REST is yourfriend
- 12. Base URLs pereach resource
- 13.
- 14.
- 15.
- 16.
- 17.
- 18.
- 19.
- 20.
- 21.
- 22. PUT is alsoused for creating
- 23. PATH for partialupdates
- 24. Verb Resource POST GET PUTDELETE /users New User List Users ? Delete Everybody /users/hossein ? Show Hossein :) Update / Create Hossein Delete Hossein :(
- 25.
- 26.
- 27.
- 28. Verb Resource POST GET PUTDELETE /users New User List Users ? Delete Everybody /users/hossein ? Show Hossein :) Update / Create Hossein Delete Hossein :(
- 29.
- 30.
- 31.
- 32.
- 34.
- 35. Keep Base URLSimple
- 36.
- 37.
- 38.
- 39.
- 40.
- 41.
- 42.
- 43.
- 44. Hypermedia As TheEngine Of Application State
- 45. GET /account/12345 HTTP/1.1 HTTP/1.1200 OK <?xml version="1.0"?> <account> <account_number>12345</account_number> <balance currency="usd">100.00</balance> <link rel="deposit" href="/account/12345/deposit" /> <link rel="withdraw" href="/account/12345/withdraw" /> <link rel="transfer" href="/account/12345/transfer" /> <link rel="close" href="/account/12345/close" /> </account>
- 46. GET /account/12345 HTTP/1.1 HTTP/1.1200 OK <?xml version="1.0"?> <account> <account_number>12345</account_number> <balance currency="usd">-30.00</balance> <link rel="deposit" href="/account/12345/deposit" /> </account>
- 47.
- 48.
- 49.
- 50.
- 51.
- 52.
- 53.
- 54.
- 55.
- 56.
- 57.
- 58.
- 59.
- 60.
- 61.
- 62.
- 63.
- 64.
- 65. Linking to comprehensiveexplanation
- 66.
- 67.
- 68.
- 69.