본 게시글은 커리어리의 게시글을 소개하는 글입니다.
프론트엔드개발자이신 김의중님의 게시글입니다.
Swagger UI
🧑💻 Swagger UI란?
Swagger UI는 개발자들이 API를 더 효과적으로 개발하고, 테스트하고, 문서화하고, 사용하게 해주는 도구의 역할로서 등장했습니다.
그 외의 특징
- API의 정의를 바탕으로 자동으로 문서를 생성 (시간을 절약)
- 실시간으로 문서를 업데이트 (동기화 문제 해결)
- 대화형 인터페이스 (API를 더 쉽게 이해하고 테스트할 수 있게 해줌)
🧑💻 이런 사람들에게 추천해요!
시간과 자원의 부족, 혹은 문서화의 중요성 인식 부족으로 인해 API 문서가 없거나, 수동으로 API문서를 만들고 있다면
시간을 절약하고, 문서의 정확성과 일관성을 유지하는데 도움을 주는 Swagger UI를 사용하는 것을 추천합니다.
🧑💻 NextJS 에서 Swagger 문서 자동 생성
NextJS 는 @nestjs/swagger 패키지를 사용하여 Swagger 문서를 자동으로 생성합니다. 데코레이터를 사용하여 API 엔드포인트와 모델에 메타데이터를 추가할 수 있습니다.
🧑💻 Spring Boot 에서 Swagger 문서 자동 생성
Spring Boot에서는 Springfox 라이브러리를 사용하여 Swagger 문서를 자동으로 생성합니다.
Springfox에서 Swagger 생성 원리
: Spring MVC의 @Controller 및 @RestController 빈에 정의된 요청 매핑 정보를 분석하여 Swagger 문서 생성
본 게시글이 문제가 될 경우 댓글을 남겨주시면 감사하겠습니다.
'Article Scrap > Careerly - Post' 카테고리의 다른 글
| AI 배워야 하나 (0) | 2023.05.19 |
|---|