OpenAPI 의 시작: Swagger

Swagger가 왜 중요한가요?

• 효율적인 API 문서화
  • 개발자들이 수동으로 문서를 작성할 필요가 없어서 시간 절약
• API의 명확한 가시성 제공
  • Swagger UI를 통해 API 동작을 시각적으로 확인 가능
• 개발 과정의 협업 강화
  • 개발자, QA, 비개발자(기획자, 디자이너) 모두가 API를 쉽게 이해하고 활용 가능
• 자동화된 API 테스트
  • API의 정상 동작 여부를 손쉽게 확인 가능

OpenAPI 스펙 파일 생성

먼저, 간단한 OpenAPI 스펙 파일을 작성합니다. 파일 이름은 swagger.yaml로 저장합니다.

openapi: 3.0.0
info:
  title: Simple API
  description: A simple example API
  version: 1.0.0
servers:
  - url: http://localhost:8080
paths:
  /hello:
    get:
      summary: Returns a greeting message
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    example: Hello, World!

 

Docker를 사용하여 Swagger 서버 시작하기

Docker CLI를 활용하려면 다음 명령어를 사용하세요:

docker run -d -p 8080:8080 \
  -v $(pwd)/swagger.yaml:/tmp/swagger.yaml \
  -e SWAGGER_JSON=/tmp/swagger.yaml \
  swaggerapi/swagger-ui