[스프링 부트] SpringBoot API Docs

SpringBoot API Docs 

: Rest API를 자동으로 관리해주며, 웹 UI툴을 제공한다.

 

1. 의존성 추가

implementation group: 'org.springdoc', name: 'springdoc-openapi-ui', version: '1.6.11'

2. yml 추가

springdoc:
  swagger-ui:
    path: shoppingMall.html
  version: v1
  paths-to-match:
    - /**

 

 

위 과정을 진행하면 http://localhost:port/v3/api-docs 로 들어 갔을 때, JSON 형태의 데이터를 받는 것을 알 수 있다.

http://localhost:port/swagger-ui/index.html 로 들어가면

위 JSON형태의 데이터를 웹 UI를 통해 가시적으로 확인이 가능하다.