Swagger UI

@Tag

name = "", description = ""

@Operation

tags = "", summary = "", description = ""

@ApiResponses - @ApiResponse

responseCode = "", description = ""

@Parameter - @RequestParam

description = "", required = "", example = ""

@Schema

@Tag(name = "swagger", description = "Swagger API 테스트")
@RestController
@RequestMapping(value = "/swagger", method = RequestMethod.GET)
public class SwaggerController {

    @Operation(tags = "swagger", summary = "swagger 테스트", description = "swagger api 예시")
    @ApiResponses({
            @ApiResponse(responseCode = "200", description = "OK"),
            @ApiResponse(responseCode = "400", description = "BAD REQUEST"),
            @ApiResponse(responseCode = "404", description = "NOT FOUND")
    })
    @GetMapping("/test")
    public ResponseEntity<String> hello(@Parameter(description = "성", required = true) @RequestParam String name,
                                        @Parameter(description = "이름", required = true) @RequestParam String name2) {
        return ResponseEntity.ok(name + " " + name2 + " 사용자가 날린 테스트 입니다");
    }
}

++

swagger 2.x -> 3.x

*io.swagger.v3.oas.annotations 사용

@Api -> @Tag
@ApiOperation -> @Operation
@ApiResponse(code = 404, message = "foo") -> @ApiResponse(responseCode = "404", description = "foo")
@ApiParam -> @Parameter
@ApiImplicitParam -> @Parameter
@ApiImplicitParams -> @Parameters
@ApiModel -> @Schema
@ApiModelProperty -> @Schema
...