반응형 Swagger2 Open API 3.0 Swagger v3 상세설정(23/01/08) 이전 포스팅에서 swagger 기능에 대해 다룬적이 있다. 아래 참고사이트에서 확인할수 있다. 이번 포스팅에서는 swagger 를 좀더 상세설정을 통해서 사용할수 있는 기능을 몇가지 적어보려고 한다. api 그룹 설정 (@Tag) restcontroller 의 서비스에 @Tag annotation 을 달아서 그룹화를 할수 있다. name 이 같은것끼리 swagger 에서 묶여서 보여진다. name: 태그의 이름 description: 태그에 대한 설명 @Tag(name = "group", description = "그룹화 예제") 이렇게 달게 되면 된다. api dto 설정 (@Schema) swagger 로 받을 dto 값에 대한 스펙을 적어둘수 있다. dto에서 컬럼마다 설정을 하며 descripti.. 2023. 1. 7. swagger-ui 사용법 스웨거란 RESTAPI 개발시 문서를 자동으로 만들어주는 프레임워크이다. 대부분 API 를 Request 날릴때 사용을 하곤 한다. 저번에 다뤘던 내용인 postman을 사용해도 되고 이 swagger를 사용해도 좋다. postman 사용은 아래 참고 포스팅을 확인해보면 된다. 자바 뿐 아니라 python이나 nodejs 에서도 사용은 가능하지만 자바 스프링에서 사용할수 있는 좋은 기능이기에 자바 카테고리로 분류를 하였다. 사용을 하려면 먼저 라이브러리를 추가해야한다. maven 경우 gradle 경우 그리고 자바 소스로 와서 swaggerconfig 파일을 생성해준다. 기존에는 여기서 되었는데 좀더 확인을 해보니 configuration 파일에 추가 설정을 해줘야했다. 그래서 변경된 코드는 아래와 같다.. 2022. 6. 30. 이전 1 다음 반응형
