Swagger 알게 된 내용 추가

[codemaker-kim]

Swagger 추가적인 사용법 학습하기

추가로 알게 된 yaml 파일 설정

Swagger 문서에 나오는 요청과 응답에 대한 기본 mediaType을 지정해줄 수 있다!

아래와 같이 추가해주자.

springdoc:
  api-docs:
    path: /v3/api-docs
  swagger-ui:
    path: /swagger-ui.html
  #추가한 값
  #요청과 응답에 대한 기본 mediaType을 지정해준다.
  default-consumes-media-type: application/json;charset=UTF-8
  default-produces-media-type: application/json;charset=UTF-8

@tag 사용법

사용하게 되면, 이 어노테이션이 붙은 클래스가 Swagger 문서로 나올 때에 대한 설명 및 내용 편집이 가능하다.
(근데 붙였는데도 안바뀐다. 이유를 모르겠음)

@parameter 사용법

request에서 정의되는 파라미터 지정(Operation에서 parameters 항목으로도 정의 가능)

근데 어째서인지 다들 제대로 작동되지 않는다..

또 다시 시행 착오를 거쳐가는 과정일까?

[codemaker-kim]

시행해본 것들

1. 일단 OpenApiConfig를 작성해서 직접 전역적으로 기본 요청 타입, 응답 타입을 제공해보기로 했다.

• 여기서 장점이 하나가 있다면, 로컬에서 만들고 작성한 Swagger 문서를 내 Swagger 허브에 업로드할 수 있다는 점이다! (아직은 시행 못해봄)

2. 여기서 악랄한 문제가 발생.

• OpenApiConfig 클래스를 작성할 때에는 Info 객체를 사용하지만 Info 클래스 자체가 추상 클래스라서 객체를 만들 수가 없다.

최종적인 Swagger 에 대해 알아봐야 할 것

1. 요청, 응답 타입 Swagger 문서에 명시되게 하기.

2. 예시 응답 내용 편집하는 방법