티스토리 뷰
Introduce
API 문서 도구는 다 비슷하지만 좋은 API 문서 도구는 저마다 이유가 다릅니다. 좋은 API 문서 도구로는 Swagger와 ReDoc이 있습니다.
Swagger는 OpenAPI 대표적인 문서화 도구입니다. API와 관련 모든 리소스 및 작업을 효과적으로 매핑이 가능하고 RESTful 인터페이스를 쉽게 개발할 수 있습니다.
Redoc은 Swagger와 동일한 OpenAPI 문서화 도구 중 하나 입니다. Swagger보다 좀 더 깔끔한 UI를 제공합니다. redoc-cli를 통해서 html 파일을 만들 수 있습니다.
두 가지 API 문서 도구의 장점은 개발자가 API를 구현하면서 문서화에 코드를 추가하지 않아도 자동으로 생성 해줍니다. 개발자는 비즈니스 로직에 더욱 집중할 수 있고 시간을 절약할 수 있습니다.
Swagger 대신 Redoc를 사용하는 이유?
Swagger 대신 Redoc를 사용하는 이유는 가독성 때문입니다. Redoc은 기본으로 3개의 패널로 구성된 레이아웃을 제공합니다. Swagger와 달리 한 번에 모든 정보를 확인 할 수 있습니다.
Swagger 기본 UI 구성은 다음과 같습니다.
Redoc 기본 UI 구성은 다음과 같습니다.
Swagger에서 기본으로 제공하는 UI 구성은 ReDoc에 비해 가독성이 떨어 집니다. Swagger에서 커스텀을 제공해 주지만 빠른 시일 안에 개발을 완료하는 입장에서는 기능 보다 가독성을 우선 시 해서 ReDoc을 선택한 이유 중 하나입니다.
Reference
'Tech' 카테고리의 다른 글
| java.sql.SQLNonTransientConnectionException 에러를 해결하기 (0) | 2023.01.25 |
|---|---|
| UninitializedPropertyAccessException 에러 해결하기 (0) | 2023.01.25 |
| 의미 있는 Git 커밋 메세지를 남기는 방법 (0) | 2023.01.14 |
| 구조 분해 할당 시 Cannot destructure property 에러를 해결하라 (0) | 2022.12.05 |
| 퀵 정렬 피벗 위치가 맨 끝에 있으면 안되는 이유 (0) | 2022.12.03 |
댓글