Package com.github.chhorz.openapi.common.annotation

Annotation Interface OpenAPI

@Documented @Retention(SOURCE) @Target(METHOD) public @interface OpenAPI
This annotation is a more structured way to document data that could be added with custom Javadoc tags. Values from this annotation have precedence over the Javadoc values. If values from this annotation are empty, data from the Javadoc comment will be used.
Author:
chhorz

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    OpenAPIResponse[]
    responses
    List of responses for the given method.
    String[]
    securitySchemes
    List of security scheme names from the oas-generator.yml file
    String[]
    tags
    List of OpenAPI tags that are described in the oas-generator.yml file.

  • Element Details

    • tags

      String[] tags
      List of OpenAPI tags that are described in the oas-generator.yml file.

      If empty the Javadoc tags @category and @tag will be evaluated.

      Default:
      {}

    • securitySchemes

      String[] securitySchemes
      List of security scheme names from the oas-generator.yml file

      If empty the Javadoc tags @security will be evaluated.

      Default:
      {}

    • responses

      OpenAPIResponse[] responses
      List of responses for the given method.

      If empty the Javadoc tags @response will be evaluated.

      Default:
      {}