RESTful Web Services with Spring MVC
26 likes10,060 views
The document provides an overview of RESTful web services using Spring MVC, covering the Richardson maturity model, resource identification, HTTP verbs, URI mapping, and content negotiation. It details best practices for designing representations, managing HTTP status codes, and implementing caching strategies. Additionally, it emphasizes the importance of HATEOAS and includes references for further reading.
RESTful Web Services with Spring MVC
- 1. RESTful Web Services With Spring MVC @DigitalSonic
- 4. • How to identify Resources • How to use HTTP Verbs • How to design Representations • Miscellaneous • Cache/Version/HATEOAS Agenda
- 5. Resources
- 6. • Domain Nouns • Collections & Composites • Functions • Controllers
- 7. • Article & Comment • http://domain/articles • http://domain/articles/1 • http://domain/articles/1/comments • Web Page • a composite of article and comments • Magazine • a collection of articles Samples
- 8. Samples • Functions • http://domain/direction?from=shanghai&to=hangzhou • Controllers • http://domain/users/smith/address_merge
- 9. Resource Granularity • Network Efficiency • Size of Representations • Client Convenience
- 10. URL Mapping in Spring MVC • <mvc:annotation-driven/> • @RequestMapping • @PathVariable • @RequestParam • @MatrixVariable
- 11. Building URI • UriComponents • UriComponentsBuilder • ServletUriComponentsBuilder
- 12. Better URI • use domains and subdomains to logically group or partition resources • use / to indicate a hierarchical relationship • use , and ; to indicate nonhierarchical elements • use - and _ to improve the readability • use & to separate parameters • avoid including file extensions
- 13. HTTP Verbs
- 14. Verbs Safety & Idempotency Usage GET Y / Y Use GET for safe and idempotent information retrieval. POST N / N Use this method to let the resource perform a variety of actions on the server side such as creating new resources, updating existing resources, or making a mixture of changes to one or more resources. DELETE N / Y Use this method to let a client delete a resource. PUT N / Y Use this method to completely update or replace an existing resource or to create a new resource with a URI specified by the client. HEAD Y / Y Use this method to retrieve the same headers as that of a GET response but without any body in the response. OPTIONS Y / Y Use this method to find the list of HTTP methods supported by any resource or to ping the server. TRACE Y / Y Use this method to let the server echo back the headers that it received.
- 15. HTTP Method in Spring MVC • @RequestMapping • RequestMethod Enum
- 16. HiddenHttpMethodFilter <input type="hidden" name="_method" value="put"/> Your web form doesn’t support so much verbs?
- 17. Representations
- 18. • Different view technologies in Spring • JSP/JSTL (InternalResourceViewResolver) • Tiles (TilesViewResolver) • XML Marshalling (MarhsallingView) • JSON Mapping (MappingJacksonJsonView) • etc. • @ResponseBody
- 19. HTML Should I say anything about this? You know what I mean.
- 20. JSON • Jackson • MappingJacksonHttpMessageConverter • Jackson 2 • MappingJackson2HttpMessageConverter
- 21. JSON • @RequestBody • @ResponseBody • @RequestMapping • consumes="application/json" • produces="application/json"
- 22. JSON • Demo • Request • curl -H "Accept: application/json" http://localhost:8080/rest- demo/articles/10
- 23. XML • JAXB 2 • Jaxb2RootElementHttpMessageConverter
- 24. Links • Link • href/rel • Atom link Ref • self/alternate/related/edit • first/last/previous/next
- 25. Content Negotiation • serval @RequestMapping with different produces • contentNegotiationManager • file extension • format parameter • Accept header • ContentNegotiatingViewResolver
- 27. HTTP Status Codes • Use the RIGHT HTTP Status Code! • @ResponseStatus • http://www.ietf.org/rfc/rfc2616.txt
- 28. HTTP Status Codes Code Description Code Description 200 OK 400 Bad Request 201 Created 401 Unauthorized 202 Accepted 403 Forbidden 301 Moved Permanently 404 Not Found 303 See Other 410 Gone 304 Not Modified 500 Internal Server Error 307 Temporary Redirect 503 Service Unavailable
- 29. Miscellaneous
- 30. Cache • Use the RIGHT Cache HTTP Headers • Cache-Control • Expires • Date • Last-Modified
- 31. Cache for Static Resources
- 32. Cache for Dynamic Resources
- 33. Support for Etags • ShallowEtagHeaderFilter
- 35. Version • Try to maintain the compatibility • URI • Representation • Link • If you can’t, then make a new version • subdomain • path segments • query parameters
- 36. HATEOAS • Hypermedia as the Engine of Application State • Spring Hateoas • https://github.com/SpringSource/spring-hateoas • Better support for Links and Resources
- 37. Demo
- 38. References
- 39. • RESTful Web Services Cookbook, O’Reilly • REST in Practice, O’Reilly • the official reference of the Spring Framework • and so many articles on the Internet
- 40. Let’s Code!!!