JYOH3246 / BackOffice

0 stars 3 forks source link

[Swagger] API 추가 설명 작성 #29

Closed lovelyunsh closed 7 months ago

lovelyunsh commented 7 months ago

image

Swagger에 @Operation 어노테이션을 이용해서 추가 설명을 붙일 수 있습니다. client 측에서 바로 알 수 없는 status의 목록 등 추가 설명이 필요한 API에는 설명을 달아 주면 좋을 것 같습니다.

사용법은 아래 링크에 잘 설명 되어 있으니 참조 바랍니다. https://www.baeldung.com/kotlin/swagger-spring-rest-api