Swagger로 REST API 문서화하기

• Swagger는 REST API 설계를 지원하는 프레임워크로, OpenAPI 명세를 기반으로 다양한 기능을 제공하며, Swagger UI와 Swagger Editor를 통해 OpenAPI를 시각화하고 작성할 수 있습니다.

• OpenAPI Specification은 REST API를 표현하기 위한 문서 표준으로, API의 요청과 응답 형태를 YAML 또는 JSON 형식으로 작성하며, 주요 구성 요소로는 openapi, info, paths, parameters, responses, components.schemas, security 등이 있습니다.

• `springdoc-openapi` 라이브러리를 사용하면 Spring Boot 환경에서 코드 기반으로 OpenAPI 명세를 자동 생성할 수 있으며, `build.gradle`에 의존성을 추가하고 `application.yml`에서 경로 설정을 통해 문서화 경로를 변경할 수 있습니다.

• `@Operation`, `@Parameter`, `@RequestBody`, `@Schema`, `@Tag` 등의 어노테이션을 사용하여 API 엔드포인트 설명, 파라미터 정보, 요청 본문 설명 등을 추가하여 OpenAPI 명세를 편집할 수 있습니다.