본문 바로가기
프레임워크/Spring Boot

[SpringBoot] springdoc으로 swagger 적용하기

by 연어바케트 2023. 5. 8.
반응형

Swagger

개발자가 REST 웹 서비스를 설꼐, 빌드, 문서화등을 도와주는 대형 도구 생태계의 지원을 받는 오픈 소스 소프트웨어 프레임워크이다. 대부분의 사용자들은 스웨거 UI도구를 통해 스웨거를 식별하며 스웨거 툴셋에는 자동화된 문서화, 코드 생성, 테스트 케이스 생성 지원이 포함된다. 

 

SpringDoc 의존성추가

https://mvnrepository.com/artifact/org.springdoc/springdoc-openapi-ui

dependencies {
	//..
    implementation("org.springdoc:springdoc-openapi-ui:1.7.0")
    //..
}

 

application파일 설정

  1 ) application.yml  

springdoc:
  default-consumes-media-type: application/json
  default-produces-media-type: application/json
  swagger-ui:
    path: /swagger-ui.html
    disable-swagger-default-url: true


  2) application.properties 추가

springdoc.swagger-ui.path=/swagger-ui.html
springdoc.swagger-ui.disable-swagger-default-url=true
springdoc.default-consumes-media-type=application/json
springdoc.default-produces-media-type=application/json


그 외의 SpringDoc properties

 

OpenAPI 3 Library for spring-boot

Library for OpenAPI 3 with spring boot projects. Is based on swagger-ui, to display the OpenAPI description.Generates automatically the OpenAPI file.

springdoc.org

 

Swagger 접속

 

Swagger 실행화면

반응형

댓글