💡 새로 알게 된 것

Postman과 Swagger UI: REST API를 다루는 필수 도구

Swagger UI

Swagger UI란?

Swagger UI는 REST API를 설계하고 문서화하며, 테스트할 수 있는 웹 기반 도구입니다. OpenAPI 명세(OpenAPI Specification)를 기반으로 동작하며, API 설계와 문서화에서 널리 사용됩니다.

Swagger UI의 주요 기능

1. API 문서화:
   • OpenAPI 명세를 읽어들여 사용자 친화적인 API 문서를 자동 생성.
2. 실시간 API 테스트:
   • Swagger UI에서 API를 바로 호출하고 응답을 확인.
3. 시각적 인터페이스:
   • 복잡한 API 구조를 한눈에 볼 수 있는 직관적인 UI 제공.
4. 팀 협업:
   • API 명세를 공유하고, 문서를 통해 팀 간 협업 지원.

Swagger UI를 사용하는 방법

1. OpenAPI 명세 파일(JSON 또는 YAML)을 작성.
2. FastAPI, Spring Boot, Flask 등 프레임워크에서 Swagger UI를 자동으로 생성하거나, 별도로 설치.
3. /docs 경로 또는 Swagger UI의 호스팅된 페이지에서 API 확인 및 테스트.

Swagger UI의 장점

• 문서화와 테스트를 한 곳에서 수행 가능.
• OpenAPI 명세 기반으로 자동화된 문서 생성.
• API 설계와 문서화가 동시에 이루어짐.

Swagger UI의 단점