250212 수 TIL

쿠키 방식 인증

쿠키 방식 인증에서는 클라이언트(프론트엔드)가 key와 token을 보유하고 있으며, 이를 통해 인증을 수행한다.

• 로그아웃 시 key 또는 token을 제거하면 인증이 해제된다.

Swagger - API 문서화 도구

Swagger는 API의 문서를 자동으로 생성해주는 도구다. Spring Boot에서는 springdoc-openapi 라이브러리를 이용해 손쉽게 Swagger를 적용할 수 있다.

주요 어노테이션

@Tag

클래스 수준에서 API 그룹을 정의할 때 사용한다.

@Tag(name = "APIV1MemberController", description = "회원 관련 API")

@Operation

API 메서드의 설명을 정의하는 데 사용한다.

@Operation(summary = "로그인", description = "로그인 성공 시 ApiKey와 AccessToken 반환. 쿠키로도 반환")

@SecurityScheme & @SecurityRequirement

• @SecurityScheme은 API 보안 설정을 정의한다.
• @SecurityRequirement은 특정 엔드포인트에서 보안 요구사항을 설정할 때 사용한다.

Mapping에서 produces 설정

produces 속성을 사용하면 응답의 컨텐츠 타입을 명시할 수 있다.

@PostMapping(value = "/join", produces = "application/json;charset=UTF-8")

이 설정을 통해 API 응답이 application/json 타입으로 인코딩되도록 보장할 수 있다.

YAML 설정에서 기본값 지정

Spring Boot의 application.yml에서 기본 응답 컨텐츠 타입을 설정할 수도 있다.

springdoc:
  default-produces-media-type: application/json;charset=UTF-8

이렇게 설정하면 produces 속성을 매번 추가하지 않아도 자동으로 application/json;charset=UTF-8 형식의 응답을 반환한다.