이번 프로젝트에서 API문서화를 하기로 했다.
이전에 개발할 때 팀원이 RestDocs와 Swagger를 함께 썼었는데 괜찮은 것 같아서 사용해보기로 하였다.
아래 포스팅을 참고하여 설정하였다.
https://velog.io/@onetuks/Swagger-RestDocs-%EB%AC%B8%EC%84%9C%ED%99%94#-%EC%BD%94%EB%93%9C-%EC%9E%91%EC%84%B1%EB%B2%95
문제점
결과를 확인하는 데 yaml 파일은 정상적인데 localhost로 확인할 때 제대로 된 결과가 나오지 않았다.
시도해본 것들
- yaml 대신 json 사용
- 빌드 clean후 재 빌드
해결
application.properties의 swagger-ui.url의 경로를 파일 위치로 변경해주니 제대로 읽었다.
이전
springdoc.swagger-ui.url=/v3/api-docs
이후
springdoc.swagger-ui.url=/docs/swagger.yaml
알게 된 점
기본적으로 api-docs의 default 위치가 /api-docs라는 것을 알았다.
우리는 docs/swagger.yaml을 호스팅 할 것이기 때문에 해당 파일의 경로로 바꿔줘야 했다.
