Downloaded 33 times
Uploaded byHüseyin BABAL
RESTful API Design Fundamentals
The document discusses fundamentals of RESTful API design including resources, representations, HTTP verbs, and versioning. Key points include: - Resources can be collections like customers or singletons like a specific customer and are identified by URIs. Sub-collections are also resources. - HTTP verbs like GET, POST, PUT, DELETE map to common CRUD operations for resources. - Resources have representations, typically JSON or XML, that are transferred in requests and responses. - Choosing resources depends on domain analysis and consumer needs. Resources can be fine-grained with separate endpoints or coarse-grained with all details at once. - Versioning is best done by specifying the version in the Accept
RESTful API Design Fundamentals
- 1. RESTful API Design Fundamentals
- 2. Resource URI Representat ions HTTP Verbs Resources
- 3. Resource Any objectassociated with data, identified with URI, and can be operated by using HTTP methods
- 4. Collection(customers) Singleton(customer) /articles/articles/{articleI d}
- 5. Sub-collections /articles/{articleId}/comments /articles/{articleId}/comments/{commentId}(Sub-collection resource)
- 6. Http Verbs ArticleCreate Article Update Article Delete
- 7. GET -> show POST -> create PUT -> update DELETE -> delete
- 8.
- 9. Resource URI UniqueResource Identifier
- 10. Choosing Resource Analyzeyour business domain Define your needs Consumer needs important
- 11. Fine Grained Resource Multiple API request (title, content, slug, etc...)
- 12. Coarse Grained Resource All the details at once. Send Article data to API
- 13. Business logic onconsumer side First create article content Attach category (mandatory) If user does not add category, then what?
- 14. …. On everyupdate on API side will reflect to consumer side
- 15. Action A dependson; Resource A Resource B Resource C
- 16. Then Action Acan be defined as; Resource X
- 17. Versioning Url shouldn’tcontain version http://yourdomain.com/api/v3.0/articles/123 (Bad)
- 18. … instead Versionin the header GET /articles/123 Accept: application/vnd.huseyinbabal.blogging.article-v3+ json
- 19. Even worse http://yourdomain.com/api/v3.0/articles/v2.5/co mments/v1.7/likes