Spring/spring-data-rest
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DATAREST-453 - Added appendix linking to Spring Data examples.

Browse Source 
Added a new section that lists Spring Data REST specific example projects.

Original pull request: #168.
This commit is contained in:
Greg Turnquist
2015-03-20 14:31:02 -05:00
committed by Oliver Gierke
parent f80bebf04b
commit 583284a9f0
3 changed files with 32 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
src/main/asciidoc/index.adoc
View File

@@ -33,3 +33,4 @@ include::customizing-sdr.adoc[leveloffset=+1]
:numbered!:
include::example-api-usage-with-curl.adoc[leveloffset=+1]
include::spring-data-rest-examples.adoc[leveloffset=+1]

2
src/main/asciidoc/projections-excerpts.adoc
View File

@@ -130,6 +130,8 @@ NOTE: The value supplied to the `projection` query parameter is the same as spec
It's possible to have multiple projections.
NOTE: Visit <<spring-data-examples.projections>> to see an example project you can experiment with.
=== Finding existing projections
Spring Data REST provides hypermedia metadata by exposing <<metadata.alps>> documents, a micro metadata format. To view the ALPS metadata, follow the `profile` link exposed by the root resource. If you navigate down to the ALPS document for `Person` resources (which would be `/alps/persons`), you can find many details about `Person` resources. Projections will be listed along with the details about the `GET` REST transitions, something like this:

29
src/main/asciidoc/spring-data-rest-examples.adoc Normal file
View File

@@ -0,0 +1,29 @@
[[spring-data-examples]]
[appendix]
= Spring Data REST example projects
This appendix contains a list of Spring Data REST sample applications. The exact version of each example isn't guaranteed to match the version of this reference manual.
NOTE: To get them all, visit https://github.com/spring-projects/spring-data-examples and either clone or download a zipball. This will give you example apps for ALL supported Spring Data projects. Simply avigate to `spring-data-examples/rest`.
[[spring-data-examples.multi-store]]
== Multi-store example
https://github.com/spring-projects/spring-data-examples/tree/master/rest/multi-store[This example] shows how to mix together several underlying Spring Data projects.
[[spring-data-examples.projections]]
== Projections
https://github.com/spring-projects/spring-data-examples/tree/master/rest/projections[This example] contains more detailed code you can use to poke around with <<projections-excerpts,projections>>.
[[spring-data-examples.spring-security]]
== Spring Data REST + Spring Security
https://github.com/spring-projects/spring-data-examples/tree/master/rest/security[This example] shows how to secure a http://projects.spring.io/spring-data-rest[Spring Data REST] application in multiple ways with http://projects.spring.io/spring-security[Spring Security].
[[spring-data-examples.starbucks]]
== Starbucks example
https://github.com/spring-projects/spring-data-examples/tree/master/rest/starbucks[This example] exposes 10843 Starbucks coffee shops via a RESTful API that allows to access the stores in a hypermedia based way and exposes a resource to execute geo-location search for coffee shops.