Annotation Interface Ok

@Retention(RUNTIME) @Target(METHOD) @Documented public @interface Ok
A convenience annotation that is itself annotated with @ApiResponse.

Methods that carry this annotation will be included in generated openApi documentation with predefined HTTP status code 200. @ResponseBody description and example will be generated according to a type returned by the method.

NOTE: @Ok is processed if annotated method is part of properly configured RestController and springdoc-openapi library.

Since:
1.0
Author:
Ilya Nikolaev
See Also:
  • ApiResponse
  • RestController

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    io.swagger.v3.oas.annotations.media.Content[]
    content
     

  • Element Details

    • content

      @AliasFor(annotation=io.swagger.v3.oas.annotations.responses.ApiResponse.class, attribute="content") io.swagger.v3.oas.annotations.media.Content[] content
      Default:
      {}