Swagger2 [Swagger] 2. Swagger3에서 Group별로 Tag 설정하기(feat. OpenApiCustomiser) 목차 1) Group이 하나일 때 비어있는 Tag(API가 없는 태그)는 Swagger-ui에 미노출하기 2) SwaggerConfig에서 path에 따라 그룹을 나누고 각 그룹별로 Tag 리스트 관리하기 API가 많아지면서 각 API를 path나 package에 따라 Group으로 나누고 해당 그룹 내에서 Tag를 별도로 관리하고 싶다는 니즈가 있었고, 추가로 Tag를 클래스 단위가 아니라 메서드에 달았을 때는 description을 작성할 수 없어서 name과 description을 모두 사용할 수 있도록 Tag를 한 번에 관리하고 싶었다. 구글링했을 때 나오듯이 SwaggerConfig에서 프로젝트에서 사용하는 모든 태그를 한 번에 관리할 수도 있지만 그 경우에 태그를 해당 그룹에서 사용하지 않더라.. 2023. 5. 16. [Swagger3] 1. springdoc-openapi를 이용한 Swagger3 설정하기(+Swagger 옵션) Swagger 기본 설정 및 Swagger에서 제공하는 기본 옵션에 대해 알아보자! 1) build.gradle dependencies 안에 openapi-ui 추가 //swagger implementation 'org.springdoc:springdoc-openapi-ui:1.7.0' 2) application.yaml springdoc: api-docs: path: /api-docs# api-docs url: localhost:8080/api-docs groups: enabled: true# group 허용 swagger-ui: path: /index.html# swagger url : localhost:8080/swagger-ui/index.html enabled: true groups-order:.. 2023. 5. 5. 이전 1 다음 반응형
