[C.S] Swagger(스웨거) 란??

Swagger(스웨거)란?

• 스웨거는 Web API 문서화를 위한 도구이다.
• Open Api Specification (OAS)를 위한 프레임워크
• API 들이 가지는 명세(Spec)를 관리하기 위한 것이다.
• Web API를 수동으로 문서화 하는것은 힘든일이지만 Web API 의 스펙이 변경되면 문서 역시 변경되어야 하는데 이를 유지 하는것은 쉽지 않다.
  Swagger를 사용하면 Web API 가 수정되더라도 문서가 자동으로 갱신 되기에 편리하다.

 

OAS(Open Api Specification)란??

간단하게 설명하면
- Open API == Specification
- Swagger == Tools for implementing the specification

RESTful 웹 서비스를 약속된 규칙에 따라 약속된 규칙에 맞게 API 스펙을 json 과 yaml 형식으로 표현
이를 통해 직접 소스코드를 보거나 추가 문서 필요없이 서비스를 이해할 수 있다.

 

Swagger 의 기능?

• 

• API Design
  • Swagger - editor 를 통해 api 를 문서화 하고 빠르게 명세 할 수 있다.
• API Development
  • Swagger - codegen 을 통해 작성된 문서를 통해 SDK 를 생성하여 빌드 프로세스를 간소화 할 수 있다.
• API Documnetation
  • Swagger - UI 를 통해 작성된 API 를 시각화 시켜준다.
• API Testing
  • Swagger - Insepctor 를 통해 API 를 시각화 하고 빠른 테스팅을 진행 할 수 있다.
• Standardize
  • Swagger - hub 를 통해 개인 , 팀원 들이 API 정보를 공유하는 Hub 이다.