Spring Boot - swagger(스웨거) 설정 [API 문서화 도구]

1번 방법

swagger 2.9.x 이후 버전과 spring 2.6.x 이후의 버전이 안 맞아서 오류가 발생한다.

그대로 사용하려면 application.yml에 다음을 추가해주면 된다.

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

2번 방법

1. build.gradle에 기존 swagger를 삭제하고 [springfox-boot-starter : 3.0.0 ] 버전을 추가해주고

implementation 'io.springfox:springfox-boot-starter:3.0.0'

2. SwaggerConfig 클래스에서

@EnableSwagger2   →   @EnableWebMvc 로 어노테이션을 변경해주면 된다.

❗문제 발생! @EnavleWebMvc로 변경할 경우 스프링의 기본 web 설정이 되지 않는 문제가 생긴다.

static resource 경로 설정이 되지 않는 문제가 발생했다. 그래서 resourceHandler를 사용해 수동 설정을 해주었다.........

이런 수정 설정을 하고 싶지 않다면 일단 @EnableWebMvc는 사용하지 말자..!

3번 방법

 https://jackyee.tistory.com/24

---

- UI는 이곳으로 접속하면 된다. 

http://localhost:8080/swagger-ui/index.html

---

springfox - 사용법

https://velog.io/@gillog/Swagger-UI-Annotation-%EC%84%A4%EB%AA%85

[Swagger UI] Annotation 설명

 

springdoc - openapi - 사용법

https://jeonyoungho.github.io/posts/Open-API-3.0-Swagger-v3-%EC%83%81%EC%84%B8%EC%84%A4%EC%A0%95/

---

Reference

* https://bcp0109.tistory.com/326 - 전체적인 방법

https://nahwasa.com/entry/%EC%8A%A4%ED%94%84%EB%A7%81%EB%B6%80%ED%8A%B8-Swagger-UI-292-300-%EB%A7%88%EC%9D%B4%EA%B7%B8%EB%A0%88%EC%9D%B4%EC%85%98-%EB%B0%A9%EB%B2%95-Spring-Boot-Swagger-UI

* https://jackyee.tistory.com/24

* swagger 의존성은 1. springfox 2. springdoc

-차이 : https://juu-code.tistory.com/23