swagger

잘 작성된 API 문서는 작업의 시간과 테스트 시간을 줄여주기 때문에 효율을 극대화시킬 수 있다. API 문서를 작성할 때 Swagger를 사용한다면 간편하게 문서를 작성할 수 있어 좋은 프레임워크로 평가 받고 있다. 이번 포스팅에서는 Swagger의 Annotation을 이용하여 API 문서의 설명을 구체화하고, Java Bean Validation을 이용하여 API 사용 시 유효성 체크에 관한 내용을 다뤄보고자 한다. 1) API 그룹 : @Tag Tag에 설정된 name이 같은 것 끼리 하나의 api 그룹으로 묶는다. @Tag(name = "member", description = "회원 API") public class MemberController { name : 태그의 이름 descriptio..
능이개발자
'swagger' 태그의 글 목록