Spring Boot/Framework

[Springboot] Swagger

오늘도개발 2024. 2. 4. 09:40

1. Swagger 란?

 - API를 문서화하고, 테스트하고, 사용자가 쉽게 이해하고 상호작용할 수 있게 하는 데 도움을 주는 강력한 도구

  1. API 문서화: API 엔드포인트, 매개변수, 요청 및 응답 형식 등을 자동으로 문서화할 수 있다.
  2. API 테스트:  API를 테스트할 수 있다.
  3. 모의 서버 제공: Swagger를 사용하면 실제 백엔드 서버 없이도 API를 테스트할 수 있는 모의 서버를 제공할 수 있다.
  4. 코드 생성: Swagger를 사용하면 API 명세서를 기반으로 클라이언트 및 서버 코드를 자동으로 생성할 수 있다.

 

2. Spring 에서 사용 방법

 - Springfox-boot-starter  를 depandencies 에 추가하여 사용 (최신 버전에서는 spring docs 사용)

 

'Spring Boot > Framework' 카테고리의 다른 글

[JPA] 영속성 컨텍스트  (0) 2024.03.11
[Springboot] JUnit TEST  (0) 2024.02.03
[Springboot] naver-api 연동  (0) 2024.02.03
[Springboot] REST Template  (0) 2024.02.03
[Springboot] Vailidation  (0) 2024.01.30