パッケージ org.springframework.data.rest.core.annotation

アノテーションインターフェース RestResource

@TargetSE({FIELDSE,METHODSE,TYPESE}) @RetentionSE(RUNTIMESE) @InheritedSE public @interface RestResource
Repository にこれでアノテーションを付けて、エクスポート方法とリンク内の rel 属性の値に影響を与えます。

Spring Data REST 2.0 では、RepositoryRestResource を使用して、リポジトリによって公開されるアイテムリソースの関係型と説明をカスタマイズできるようにすることをお勧めします。

作成者:
Jon Brisbin, Oliver Gierke

  • オプション要素の概要

    オプション要素
    修飾子と型
    オプションの要素
    説明
    Description
    description
    コレクションリソースの説明。
    boolean
    exported
    このリソースがエクスポートされるかどうかを示すフラグ。
    StringSE
    path
    このリソースがエクスポートされるパスセグメント。
    StringSE
    rel
    このリソースへのリンクを生成するときに使用する rel 値。

  • 要素の詳細

    • exported

      boolean exported
      このリソースがエクスポートされるかどうかを示すフラグ。
      戻り値:
      リソースをエクスポートする場合は true、それ以外の場合は false。
      デフォルト:
      true

    • path

      StringSE path
      このリソースがエクスポートされるパスセグメント。
      戻り値:
      有効なパスセグメント。
      デフォルト:
      ""

    • rel

      StringSE rel
      このリソースへのリンクを生成するときに使用する rel 値。
      戻り値:
      有効な rel 値。
      デフォルト:
      ""

    • description

      Description description
      コレクションリソースの説明。
      戻り値:
      デフォルト:
      @org.springframework.data.rest.core.annotation.Description（""）