출근 첫째날

1. api 그룹 설정 : @Tag

name : 태그의 이름
description : 태그에 대한 설명

Tag에 설정된 name이 같은 것 끼리 하나의 api 그룹으로 묶습니다.
주로 Controller Class 나 Controller Method 영역에 설정합니다.

import io.swagger.v3.oas.annotations.tags.Tag;

@Tag(name = "user", description = "사용자 API")
@RequestMapping(value = "${demo.api}/users")
@RestController
public class UserController {
  ...
}

UserController 에 @Tag를 설정해 보았습니다.

@Tag 애너테이션 설정을 완료한 후 Swagger UI 화면입니다. 태그명과 설명이 각 태그에 설정되었습니다.

3. api 상세 정보 설정 : @Operation

summary : api에 대한 간략 설명
description : api에 대한 상세 설명
responses : api Response 리스트
parameters : api 파라미터 리스트

애너테이션으로 api 동작에 대한 명세를 작성하는 애너테이션으로, Controller method에 설정합니다.

Swagger UI가 fold상태일때도 간략히 확인할 수 있는 간략정보는 summary에 작성하고, 필요에 따라 상세 정보를 표기하고자 한다면 description에 설명을 추가하면 됩니다.
responses는 아래에서 설명할 @ApiResponse 리스트들 설정하는 요소입니다.
parameters는 path, query, header, cookie 등의 형태로 들어오는 파라미터에 대한 정보를 설정하는 요소입니다.

@GetMapping("/{id}")
@Operation(summary = "회원 조회", description = "id를 이용하여 user 레코드를 조회합니다.")
public ResponseEntity<? extends BasicResponse> select(
    @Parameter(description = "user 의 id") @PathVariable("id") long id) {
  ...
}

위의 코드는 summary와 description을 설정한 회원조회 api입니다.

@Operation 설정 후, Swagger UI에 메서드에 대한 설명글이 추가되었습니다.

https://blog.jiniworld.me/91#a01

https://intrepidgeeks.com/tutorial/simplify-spring-jdbc-templates

jsp > ajax > controller > dao ( jdbc templates > listforquery 실행 > sql 실행 결과 반환 ) > controller > ajax > jsp