swagger 사용시 유용함. @Tag, @Operation

@Tag와 @Operation 어노테이션은 OpenAPI (예전의 Swagger)에서 제공하는 어노테이션으로, API 문서를 자동으로 생성하는 데 사용됩니다. 이 어노테이션들을 사용하면 API의 설명을 더 명확하고 이해하기 쉽게 만들 수 있습니다.

@Tag

@Tag 어노테이션은 API의 그룹을 지정하는 데 사용됩니다. 이를 통해 API 문서에서 특정 기능별로 API를 묶어서 보여줄 수 있습니다.

예를 들어:

java

@Tag(name = "Store 관리 API", description = "사장 유저가 가게 생성, 폐업, 조회기능 API입니다.")

위와 같이 사용하면 Store 관리 API라는 이름으로 이 그룹에 속한 API들이 문서화됩니다.

@Operation

@Operation 어노테이션은 각각의 API 엔드포인트에 대한 설명을 추가하는 데 사용됩니다. 이 어노테이션을 사용하면 해당 엔드포인트의 기능을 설명하고, 파라미터와 응답에 대한 정보를 제공할 수 있습니다.

예를 들어:

java

@Operation(summary = "가게 생성", description = "사장 유저가 가게를 생성할 수 있습니다.")
@PostMapping
public ResponseEntity<StoreResponseDto> save(@RequestBody @Valid StoreRequestDto requestDto, HttpServletRequest request) {
    // 메서드 구현
}

위와 같이 사용하면 가게 생성 엔드포인트에 대한 설명이 API 문서에 포함됩니다.

이 어노테이션들을 사용하면 API 문서가 자동으로 생성되며, 이를 통해 API 사용자가 더 쉽게 API를 이해하고 사용할 수 있습니다.