Annotation Interface OpenApi.Server

Enclosing class:
OpenApi
@Target({TYPE,METHOD}) @Retention(CLASS) @Repeatable(OpenApi.Servers.class) @Documented public static @interface OpenApi.Server
OpenAPI Server Object metadata.

Type-level usage applies only to @OpenApi.Document metadata types. Method-level usage applies to generated operations.

  • Element Details

    • value

      String value
      Server URL.
      Returns:
      URL

    • description

      String description
      Server description.
      Returns:
      description
      Default:
      ""

    • variables

      OpenApi.ServerVariable[] variables
      Server variables.
      Returns:
      server variables
      Default:
      {}

    • name

      String name
      Server name.

      Rendered only for OpenAPI 3.2 output.

      Returns:
      name
      Default:
      ""