Annotation Interface ApiDocServer

@Retention(RUNTIME) @Target({}) @Documented public @interface ApiDocServer
Describes a server entry for generated API documentation.
See Also:

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    url
    Server URL, such as https://api.example.com.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    description
    Optional human-readable server description.

  • Element Details

    • url

      String url
      Server URL, such as https://api.example.com.

    • description

      String description
      Optional human-readable server description.
      Default:
      ""