Package dev.relism.flash.ext.openapi

Annotation Interface ApiOperation

@Retention(RUNTIME) @Target(TYPE) public @interface ApiOperation
Declares OpenAPI operation metadata for a class-based handler. Picked up by OpenApiExtension via
invalid reference 
FlashApp#register
. 

 @GET("/api/blogs")
 @ApiOperation(summary = "List all blogs", tags = {"blogs"})
 public class ListBlogs extends JacksonHandler { ... }

  • Element Details

    • summary

      String summary
      Default:
      ""

    • description

      String description
      Default:
      ""

    • tags

      String[] tags
      Default:
      {}

    • deprecated

      boolean deprecated
      Default:
      false

    • operationId

      String operationId
      Default:
      ""