swagger

개요GlowGrow 프로젝트는 JWT 토큰 기반의 인증 시스템을 사용하고 있습니다. Swagger를 통해 API를 테스트할 때도 실제 운영 환경과 동일하게 JWT 토큰 인증이 필요합니다.Swagger UI에서 JWT 토큰을 사용하기 위해서는 특별한 Configuration 설정이 필요한데, 본 글에서는 이러한 JWT 토큰 인증을 위한 Swagger Configuration 설정 방법과 그 동작 원리에 대해 정리하고자 합니다. 설정 방법1. 기본 API 정보 설정@OpenAPIDefinition( info = @Info( title = "Glow-Grow Payment Service", version = "1.0.0", description = "팀 T키타카의 G..

Swagger 주요 어노테이션OpenAPI 3.x에 대응하는 주요 Swagger 어노테이션은 다음과 같습니다.@Operation@Operation(summary = "허브 목록 조회", description = "모든 허브의 정보를 조회합니다.")API 엔드포인트에 대한 정보를 제공하는 어노테이션입니다.summary, description, tags, responses 등을 설정할 수 있습니다.@Parameter@Parameter(name = "hubId", description = "조회할 허브의 ID", example = "123e4567-e89b-12d3-a456-426614174000") 엔드포인트의 매개변수에 대한 설명을 추가하는 어노테이션입니다.name, description, example ..

API 명세서는 프론트엔드 개발자뿐만 아니라 다양한 관련된 사람들이 참조할 수 있어야 합니다. 초기 프로젝트에서는 API가 자주 변경될 수 있으므로, 그에 따라 API 명세서를 지속적으로 수정하는 것이 번거로울 수 있습니다. 이런 경우 Swagger와 같은 도구를 사용하면 API 명세서를 자동으로 생성하고 업데이트할 수 있어, 명세서를 보다 쉽게 관리할 수 있습니다. Swagger란❓Swagger는 RESTful API를 문서화하고 시각화하는 도구로, 개발자가 API를 설계하고 구현하는 과정에서 매우 유용하게 사용됩니다. 특히 Swagger는 API 명세서를 자동으로 생성해주는 기능을 제공하여, 개발자가 일일이 문서를 작성할 필요 없이 코드에 기반해 자동으로 최신 API 정보를 반영할 수 있도록 돕습니다..