Spring Data REST - Reference Documentation

Jon Brisbin, Oliver Gierke, Greg Turnquist version 2.5.2.RELEASE, 2016-06-15

© 2012-2015 Original authors

Table of Contents

• Preface
  • 1. Project metadata
  • 2. Dependencies
    • 2.1. Dependency management with Spring Boot
    • 2.2. Spring Framework
• Reference Documentation
  • 3. Introduction
  • 4. Getting started
    • 4.1. Introduction
    • 4.2. Adding Spring Data REST to a Spring Boot project
    • 4.3. Adding Spring Data REST to a Gradle project
    • 4.4. Adding Spring Data REST to a Maven project
    • 4.5. Configuring Spring Data REST
    • 4.6. Basic settings for Spring Data REST
      • 4.6.1. Which repositories get exposed by defaults?
      • 4.6.2. Changing the base URI
      • 4.6.3. Changing other Spring Data REST properties
    • 4.7. Starting the application
  • 5. Repository resources
    • 5.1. Fundamentals
      • 5.1.1. Default status codes
      • 5.1.2. Resource discoverability
    • 5.2. The collection resource
      • 5.2.1. Supported HTTP Methods
    • 5.3. The item resource
      • 5.3.1. Supported HTTP methods
    • 5.4. The association resource
      • 5.4.1. Supported HTTP methods
    • 5.5. The search resource
      • 5.5.1. Supported HTTP methods
    • 5.6. The query method resource
      • 5.6.1. Supported HTTP methods
  • 6. Paging and Sorting
    • 6.1. Paging
      • 6.1.1. Previous and Next Links
    • 6.2. Sorting
  • 7. Domain Object Representations
    • 7.1. Object Mapping
      • 7.1.1. Adding custom (de)serializers to Jackson’s ObjectMapper
  • 8. Projections and Excerpts
    • 8.1. Projections
      • 8.1.1. Finding existing projections
      • 8.1.2. Bringing in hidden data
    • 8.2. Excerpts
    • 8.3. Excerpting commonly accessed data
  • 9. Conditional Operations with Headers
    • 9.1. ETag, If-Match, and If-None-Match headers
    • 9.2. If-Modified-Since header
    • 9.3. Architecting a more efficient frontend
  • 10. Validation
    • 10.1. Assigning Validators manually
  • 11. Events
    • 11.1. Writing an ApplicationListener
    • 11.2. Writing an annotated handler
  • 12. Integration
    • 12.1. Programmatic Links
  • 13. Metadata
    • 13.1. Application-Level Profile Semantics (ALPS)
      • 13.1.1. Hypermedia control types
      • 13.1.2. ALPS with Projections
      • 13.1.3. Adding custom details to your ALPS descriptions
    • 13.2. JSON Schema
  • 14. Security
    • 14.1. @Pre and @Post security
    • 14.2. @Secured security
    • 14.3. Enabling method level security
  • 15. Tools
    • 15.1. The HAL Browser
  • 16. Customizing Spring Data REST
    • 16.1. Customizing item resource URIs
    • 16.2. Configuring the REST URL path
      • 16.2.1. Handling rels
      • 16.2.2. Hiding certain repositories, query methods, or fields
      • 16.2.3. Hiding repository CRUD methods
    • 16.3. Adding Spring Data REST to an existing Spring MVC Application
      • 16.3.1. More on required configuration
    • 16.4. Overriding Spring Data REST Response Handlers
    • 16.5. Customizing the JSON output
      • 16.5.1. The ResourceProcessor interface
      • 16.5.2. Adding Links
      • 16.5.3. Customizing the representation
    • 16.6. Adding custom (de)serializers to Jackson’s ObjectMapper
      • 16.6.1. Abstract class registration
      • 16.6.2. Adding custom serializers for domain types
• Appendix
  • Appendix A: Using cURL to talk to Spring Data REST
  • Appendix B: Spring Data REST example projects
    • Multi-store example
    • Projections
    • Spring Data REST + Spring Security
    • Starbucks example