Module neberus.core
Package net.oneandone.neberus.annotation

Annotation Type ApiUsecase

  • @Target(TYPE)
@Retention(SOURCE)
@Repeatable(ApiUsecases.class)
@Inherited
public @interface ApiUsecase
    Defines a specific usecase of the REST service. Usecases must be defined in seperate classes or interfaces apart from the normal apidoc. The javadoc of the defining class (must be placed above the annotations) will be used as introduction.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String name
      Name of the usecase.

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.String description
      General description of the usecase.
      ApiUsecaseMethod[] methods
      The REST methods to be used for this usecase in order of definition.

    • Element Detail

      • name

        java.lang.String name
        Name of the usecase.
        Returns:
        the name

      • description

        java.lang.String description
        General description of the usecase.
        Returns:
        the description
        Default:
        ""

      • methods

        ApiUsecaseMethod[] methods
        The REST methods to be used for this usecase in order of definition.
        Returns:
        the used methods
        Default:
        {}