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

Annotation Type ApiUsecaseMethod

  • @Target({})
@Retention(SOURCE)
public @interface ApiUsecaseMethod
    A specific REST method used in an usecase. If the method is documented within the same service, it can be referenced by providing the restClass and name (label) of the method. In this case a link will be created and all parameters and responseValues will be cross-checked so they actually exist in the documented method.

    • Required Element Summary

      Required Elements 
      Modifier and Type Required Element Description
      java.lang.String description
      Description of the usage of this method.
      java.lang.String httpMethod
      HttpMethod to use with the provided path.
      java.lang.String path
      Path of the method to call.

    • Element Detail

      • path

        java.lang.String path
        Path of the method to call. Existing methods with matching path and httpMethod will be linked.
        Returns:
        the path

      • httpMethod

        java.lang.String httpMethod
        HttpMethod to use with the provided path.
        Returns:
        the httpMethod

      • description

        java.lang.String description
        Description of the usage of this method.
        Returns:
        the description

      • parameters

        ApiUsecaseParam[] parameters
        Usage explanation of the parameters (header|query|path).
        Returns:
        the parameters
        Default:
        {}

      • requestBody

        ApiUsecaseRequestBody[] requestBody
        Custom example of the request body for the usecase.
        Returns:
        the request body
        Default:
        {}

      • responseBody

        ApiUsecaseResponseBody[] responseBody
        Custom example of the response body for the usecase.
        Returns:
        the response body
        Default:
        {}