Package pro.nikolaev.restutils.annotations.swagger.clienterrors

Annotation Interface BadRequest

@Retention(RUNTIME)
@Target(METHOD)
@Documented
public @interface BadRequest

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 400. @ResponseBody description and example will be generated according to ApiError schema description and example.

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

Since:

1.0

Author:

Ilya Nikolaev

See Also:

• ApiResponse
• ResponseEntity
• RestController
• ApiError