Annotation Interface ApiEndpoint.Param

Enclosing class:
ApiEndpoint

@Target(METHOD) @Retention(RUNTIME) @Documented public static @interface ApiEndpoint.Param
Since:
1.0
  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    Description of the parameter.
    Name of a parameter in the request handler.
  • Element Details

    • name

      String name
      Name of a parameter in the request handler. Name must match for the documentation to be displayed.
    • desc

      String desc
      Description of the parameter.