Package org.springframework.data.rest.core.annotation

Annotation Interface RepositoryRestResource

@Target(TYPE) @Retention(RUNTIME) @Inherited public @interface RepositoryRestResource
Annotate a Repository with this to customize export mapping and rels.
Author:
Oliver Gierke

  • Element Details

    • exported

      boolean exported
      Flag indicating whether this resource is exported at all.
      Returns:
      true if the resource is to be exported, false otherwise.
      Default:
      true

    • path

      String path
      The path segment under which this resource is to be exported.
      Returns:
      A valid path segment.
      Default:
      ""

    • collectionResourceRel

      String collectionResourceRel
      The rel value to use when generating links to the collection resource.
      Returns:
      A valid rel value.
      Default:
      ""

    • collectionResourceDescription

      Description collectionResourceDescription
      The description of the collection resource.
      Returns:
      Default:
      @org.springframework.data.rest.core.annotation.Description("")

    • itemResourceRel

      String itemResourceRel
      The rel value to use when generating links to the item resource.
      Returns:
      A valid rel value.
      Default:
      ""

    • itemResourceDescription

      Description itemResourceDescription
      The description of the item resource.
      Returns:
      Default:
      @org.springframework.data.rest.core.annotation.Description("")

    • excerptProjection

      Class<?> excerptProjection
      Configures the projection type to be used when embedding item resources into collections and related resources. Defaults to RepositoryRestResource.None, which indicates full rendering of the items in a collection resource and no inlining of related resources.
      Returns:
      Default:
      org.springframework.data.rest.core.annotation.RepositoryRestResource.None.class