Swagger는 OAS(Open Api Specification)를 위한 오픈소스 프레임워크입니다.
즉, API의 문서를 자동으로 정리해주는 것 입니다.
해당 Swagger를 협업하는 개발자에게 전달하면 Path, Request, Response, 제약 조건 등을 한 번에 알 수 있습니다.
API 문서 자동화 뿐만 아니라, Swagger를 통해 파라미터를 넣어보고 테스트를 진행할 수 있습니다.
API 문서를 작성하는 시간을 절약할 수 있고, API 정보를 실시간으로 유지할 수 있다는 장점이 존재합니다
왜 사용할까?
Swagger를 사용하는 이유는 다음과 같다.
- 적용하기 쉽다.. Spring REST Docs라는 문서화 도구와는 달리 Swagger는 코드 몇 줄만 추가하면 만들 수 있다!
- 테스트 할 수 있는 UI를 제공한다. Spring REST Docs는 테스트를 돌리면서 성공하는지 실패하는지 확인하지만 Swagger는 문서 화면에서 API를 바로 테스트 할 수 있다.
연관된 글:
참고:
[Spring] API 문서 자동화를 위한 Swagger 3.0.0 적용
'개발 > 개발지식' 카테고리의 다른 글
| [생성 패턴] 싱글톤 패턴(Singleton pattern) (0) | 2023.02.22 |
|---|---|
| REST API (0) | 2023.02.21 |
| 디자인패턴 (0) | 2023.02.21 |
| 소프트웨어 아키텍처(SoftWare Architecture) (0) | 2023.02.21 |
| 트러블 슈팅 (0) | 2023.02.19 |
