Package io.micronaut.openapi.visitor

Class TagUtils

java.lang.Object
io.micronaut.openapi.visitor.TagUtils
@Internal public final class TagUtils extends Object
OpenAPI tag utilities.
Since:
6.15.1

  • Constructor Summary

    Constructors
    Constructor
    Description
    TagUtils()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    addTagIfNotPresent(String tag, io.swagger.v3.oas.models.Operation swaggerOperation)
     
    static List<io.swagger.v3.oas.models.tags.Tag>
    generationTags(io.micronaut.inject.ast.ClassElement element, String classDescription, io.micronaut.inject.visitor.VisitorContext context)
    Generating tags by class name or/and by package name.
    static <T, A extends Annotation>
    List<T>
    processOpenApiAnnotation(io.micronaut.inject.ast.Element element, io.micronaut.inject.visitor.VisitorContext context, Class<A> annotationType, Class<T> modelType, List<T> tagList)
    Converts annotation to model.
    static List<io.swagger.v3.oas.models.tags.Tag>
    readTags(io.micronaut.inject.ast.ClassElement element, io.micronaut.inject.visitor.VisitorContext context)
     
    static void
    readTags(io.micronaut.inject.ast.MethodElement element, io.micronaut.inject.visitor.VisitorContext context, io.swagger.v3.oas.models.Operation swaggerOperation, List<io.swagger.v3.oas.models.tags.Tag> classTags, io.swagger.v3.oas.models.OpenAPI openApi)
     
    static List<io.swagger.v3.oas.models.tags.Tag>
    readTags(List<io.micronaut.core.annotation.AnnotationValue<io.swagger.v3.oas.annotations.tags.Tag>> tagAnns, io.micronaut.inject.visitor.VisitorContext context)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • TagUtils

      public TagUtils()

  • Method Details

    • processOpenApiAnnotation

      public static <T, A extends Annotation> List<T> processOpenApiAnnotation(io.micronaut.inject.ast.Element element, io.micronaut.inject.visitor.VisitorContext context, Class<A> annotationType, Class<T> modelType, List<T> tagList)
      Converts annotation to model.
      Type Parameters:
      T - The model type.
      A - The annotation type.
      Parameters:
      element - The element to process.
      context - The context.
      annotationType - The annotation type.
      modelType - The model type.
      tagList - The initial list of models.
      Returns:
      A list of model objects.

    • readTags

      public static void readTags(io.micronaut.inject.ast.MethodElement element, io.micronaut.inject.visitor.VisitorContext context, io.swagger.v3.oas.models.Operation swaggerOperation, List<io.swagger.v3.oas.models.tags.Tag> classTags, io.swagger.v3.oas.models.OpenAPI openApi)

    • addTagIfNotPresent

      public static void addTagIfNotPresent(String tag, io.swagger.v3.oas.models.Operation swaggerOperation)

    • readTags

      public static List<io.swagger.v3.oas.models.tags.Tag> readTags(io.micronaut.inject.ast.ClassElement element, io.micronaut.inject.visitor.VisitorContext context)

    • readTags

      public static List<io.swagger.v3.oas.models.tags.Tag> readTags(List<io.micronaut.core.annotation.AnnotationValue<io.swagger.v3.oas.annotations.tags.Tag>> tagAnns, io.micronaut.inject.visitor.VisitorContext context)

    • generationTags

      public static List<io.swagger.v3.oas.models.tags.Tag> generationTags(io.micronaut.inject.ast.ClassElement element, String classDescription, io.micronaut.inject.visitor.VisitorContext context)
      Generating tags by class name or/and by package name.
      Parameters:
      element - element
      classDescription - custom class description
      context - visitor context
      Returns:
      generated tags by controller name or/and by package class name