반응형
SMALL
open api specification
-
Spring swagger 적용 방법 (springdoc-openapi)백엔드 2023. 9. 18. 20:01
Swagger란? Swagger는 Open Api Specification(OAS)을 위한 프레임워크입니다. OAS는 RESTful 웹 서비스를 설명, 생산, 소비 및 시각화하기 위한 기계 판독 가능 인터페이스 정의 언어에 대한 사양을 뜻합니다. 직접 소스 코드를 보지 않고도 서비스를 이해할 수 있도록 해주는 것입니다. Swagger는 개발한 REST API를 편리하게 문서화해주고, 이를 통해서 관리 및 제 3의 사용자가 편리하게 API를 호출해보고 테스트 할 수 있는 프로젝트입니다. 다만, 주의할 점은 운영환경과 같은 외부에 노출되면 안되는 곳에서의 사용은 주의해야 합니다. Spring Boot에서는 springfox와 springdoc을 통해 Swagger를 사용할 수 있습니다. springfox의 ..