Package io.contextmap.annotations.rest

Annotation Type ContextRestApi

@Target(TYPE) @Retention(RUNTIME) public @interface ContextRestApi
Annotation used to document a REST API.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    name
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
     

  • Element Details

    • name

      String name
      Returns:
      the name of the REST API

    • description

      String description
      Returns:
      the description of the REST API (optional)
      Default:
      ""