PL-config-swagger: Swagger Docs 설정

[Hexeong]

Swagger Docs 설정

상위 릴리스

BR-003-A: BE Configuration

하위 이슈

• DS-config-swagger: SwaggerConfig 생성
• DS-config-security: Swagger에 대해서 토큰이 없어도 요청이 되도록 허용
• DS-controller-domain: 모든 도메인에 @operation, @apiresponse로 API 주석 추가
• DS-refactor-request-header: Swagger에서 요청 보낼시 Authorization 헤더값이 들어가지 않는 이슈 해결 #41

[DS-config-swagger] SwaggerConfig 설정 파일을 생성한다

Note

version은 springdoc-openapi-starter-webmvc-ui:2.1.0로 Spring Boot 3.3.4에 맞는 2.x 버전을 사용함

[DS-config-security] Swagger에 대한 URL과 정적 리소스에 대한 URL에 대해 허용하는 로직 추가

Note

"/", "/login", "/v3/api-docs/", "/swagger-ui/", "/swagger-ui.html",
"/swagger-resources/", "/webjars/", "/configuration/ui", "/configuration/security", "/error"
에 대해 허용한다.

[DS-controller-domain] 모든 도메인에 @operation, @apiresponse로 API 주석 추가

Note

200(Ok), 201(Created), 400(Bad Request), 401(Unauthorized), 404(Not Found)로 상태코드 나눌 예정