Swagger

• REST 웹 서비스를 설계, 빌드, 문서화, 소비하는 일을 도와주는 대형 도구 생태계의 지원을 받는 오픈 소스 소프트웨어 프레임워크
  AQUA AD swagger (http://192.168.0.115:7900/swagger-ui/index.html)

기능

1. API 문서 자동 작성
2. API 테스트

사용

1. Swagger UI server

• UI server를 따로 두고 거기서 server로 요청을 보내는 방식
  yaml 파일로 설정하여 사용

2. BE server 이용 (우리가 사용하는 방식)

• 설정
  - gradle.build에 dependency 설정(spring-fox 또는 spring-doc) -> 못찾음.. 찾아보기
  - SwaggerConfig.java 파일로 swagger UI에 표시하고 싶은 내용 설정
  - server 가동 후 URL/swagger-ui/index.html 로 접속하면 swagger UI 확인
• 적용
  • controller class 선언부에 annotation 통해 이름, 설명 설정
• annotation
  • @Tag (@Tag(name = "ANALYSIS", description = "about analysis") )
    • API 엔드포인트에 태그를 할당하여 관련된 엔드포인트를 그룹화하고 문서에서 카테고리를 형성
      주로 @RestController가 붙어있는 클래스에 사용
  • @Operation
    - API 엔드포인트의 작업에 대한 설명을 추가하고 세부 정보를 제공
    메서드에 사용
  • @Schema
    • API 모델의 속성을 정의하고 문서화, DTO 클래스나 필드에 사용

• 참고 :
  https://yozm.wishket.com/magazine/detail/2195/
  https://m.blog.naver.com/hj_kim97/222652876898
  https://woo-chang.tistory.com/80