[feat] #279 - Swagger 그룹별 API 경로 설정 및 기타 세부 설정 추가

[hoonyworld]

Related issue 🛠

• closes [feat] swagger 명세서에서 관리자와 일반 유저 section 분리 #279

Work Description ✏️

• Swagger 그룹별 API 경로 설정 및 기타 세부 설정을 추가하였습니다.
• 자세한 내용은 아래와 같습니다.

springdoc:
  # Fully Qualified Name을 사용하지 않도록 설정. (기본값: true)
  use-fqn: false

  # 기본적으로 요청을 받을 때의 미디어 타입을 설정. 여기서는 JSON 형식으로 지정
  default-consumes-media-type: application/json;charset=UTF-8

  # 기본적으로 응답할 때의 미디어 타입을 설정. 여기서는 JSON 형식으로 지정
  default-produces-media-type: application/json;charset=UTF-8

  # Swagger UI에서 그룹을 나누기 위한 설정
  group-configs:
    # 'admin' 그룹에 해당하는 API 경로를 /api/admin/**로 설정
    - group: admin
      paths-to-match: /api/admin/**

    # 'general' 그룹에 해당하는 API 경로를 /api/**로 설정하되, /api/admin/**는 제외
    - group: general
      paths-to-match: /**            # 모든 경로를 포함
      paths-to-exclude: /api/admin/** # '/api/admin/**' 경로는 제외

  # Swagger UI 관련 설정
  swagger-ui:
    # Swagger UI에서 API 목록을 태그 알파벳 순으로 정렬
    tags-sorter: alpha

    # Swagger UI에서 API 목록을 작업(Operation) 알파벳 순으로 정렬
    operations-sorter: alpha

    # Swagger UI에서 요청 시간(실행 시간)을 표시
    display-request-duration: true

Trouble Shooting ⚽️

Related ScreenShot 📷

general group

admin group

Uncompleted Tasks 😅

To Reviewers 📢

[hyerinhwang-sailin]

swagger 보기가 훨씬 편해졌네요! 좋습니다 👍