<aside> 🌐

접속 링크

</aside>

1️⃣ Swagger 기본 어노테이션 가이드라인

0. 기본 구조

@Tag(name = "API 그룹 이름", description = "API 그룹 설명")
public interface ExamplePostControllerDocs { // swagger용 docs interface

		@Operation(summary = "API 요약", description = "API 설명")
		@ApiErrorStandard // 기본적인 (401, 404, 500) 에러 swagger 작성해줌.
		@ApiError400      // 400 에러의 기본적인 에러 swgger 작성해줌
		@ApiResponse(responseCode = "응답 코드(200, 400,)", description = "응답 설명", 
									useReturnTypeSchema = true)
		ApiTemplate<PostResponse> createPost(
				@RequestBody(description = "게시글 생성 요청") PostRequest request);
		
		...
}

1. @Tag

📌 설명: 컨트롤러 단위의 API 그룹을 지정합니다.

작성법:

@Tag(name = "회원 API", description = "회원 생성, 조회, 수정, 삭제 API")
public interface ExampleUserControllerDocs { // Controller Docs
...
}

🧾 Swagger UI 결과:

제목으로 “게시글 API"이라는 그룹으로 API가 묶여 표시됨

2. @Operation