feat: Swagger로 API 문서화

[mojh7]

📃 설명

• API 문서화 restdocs 쓰려했으나 해당 프로그램 본 세션에서 Swagger를 통한 API 문서화 실습이 있어서 미리 swagger 써보기
• springfox vs springdoc
  • springfox는 2020년이 마지막 업데이트
  • springdoc는 2023년에도 업데이트중
• Swagger은 원래 Java, Spring 전용 프레임워크가 아니다
  • 정확히는 OAS (OpenAPI Specification)를 위한 프레임워크라고 한다.
  • Java외에 언어별로 전부 사용할 수 있다.
  • 그래서 Spring 환경에서 Swagger를 사용하려면 Swagger UI의 설정, Swagger 어노테이션으로 API 메타데이터를 읽는 과정 등을 직접 구현해줘야 하는데, 이런 번거로운 작업을 대신해주는 라이브러리를 SpringDoc 또는 SpringFox를 사용한다고함
• Spring Boot 3 이전 버전 vs Spring Boot 3
  • 3 이전 버전은 org.springdoc:springdoc-openapi-ui 사용
  • 3 버전은 org.springdoc:springdoc-openapi-starter-webmvc-ui 사용

✅ 작업 내용

• Swagger 도입
• API 문서화

💬 기타 사항

참고

• https://hogwart-scholars.tistory.com/entry/Spring-Boot-SpringDoc%EA%B3%BC-Swagger%EB%A5%BC-%EC%9D%B4%EC%9A%A9%ED%95%B4-API-%EB%AC%B8%EC%84%9C%ED%99%94-%EC%9E%90%EB%8F%99%ED%99%94%ED%95%98%EA%B8%B0
• https://adjh54.tistory.com/72