[REFACTOR] Swagger 접근 제한

[kyum-q]

📌 어떤 기능을 리팩터링 하나요?

외부인이 swagger를 통해 쉽게 post 요청을 보내지 못하게 swagger에서 post 요청을 제한해야 한다. 외부인이 우리 서버의 API 명세를 확인할 수 없도록 하기 위해 Swagger 접근 제한이 필요하다.

AS-IS

개발 및 배포 서버 모두 제한없이 swagger 접근이 가능하며, try it out에 제한이 없다.

TO-BE

1. post 요청일 경우 try it out을 제한한다.
2. 관리자 권한을 비밀번호를 통해 확인한다.

원하는 결과

시간 여건 상 1번 방안으로 진행 후 2번 방안 도입 예정

📜 작업 상세 내용

• [x] 개발 서버 Swagger는 현재와 동일하게 모든 요청을 try it out을 할 수 있다
• [x] 배포 서버 Swagger에서 post 요청일 경우 try it out을 제한한다
• [ ] Swagger 페이지 접근 시, 관리자 권한 확인
• [ ] 관리자 비밀번호 암호화 (고려)

⏳ 예상 소요 시간

1번 방식 : 2시간 2번 방식 : 1~3일

🔍 참고할만한 자료(선택)

[kyum-q]

try it out 막기

개발 Swagger는 현재와 동일하게 모든 요청을 try it out

yml 파일 설정으로 해결

springdoc:
  swagger-ui:
    supportedSubmitMethods: get # get만 submit 버튼 활성화 
    display-request-duration: true # API 요청 실행 시간을 화면에 표시

profile에 따라 설정 다르게 yml 파일 설정

spring:
  config:
    activate:
      on-profile: dev
springdoc:
  swagger-ui:
    supportedSubmitMethods: get, post, delete
    display-request-duration: true

---
spring:
  config:
    activate:
      on-profile: prod
springdoc:
  swagger-ui:
    supportedSubmitMethods: get
    display-request-duration: false