전자정부 프레임워크 공통컴포넌트(KRDS 및 MSA) 적용 시 Swagger 적용 방법 문의
- 작성자 :
- 고*선
- 작성일 :
- 2025-05-14 11:26:19
- 조회수 :
- 75
- 구분 :
- 공통컴포넌트 / 4.3
- 진행상태 :
- 완료
Q
안녕하세요, 전자정부 프레임워크를 이용해 데모를 구축 중인 개발자입니다.
현재 egovframe-common-components-msa-krds.zip 파일을 사용하여 공통컴포넌트 26종을 KRDS 및 MSA 환경에 적용하고 있습니다.
이와 관련하여 Swagger 적용 방법에 대해 문의 드립니다.
Swagger를 통해 API 문서화를 적용하려고 하는데, 해당 배포 파일 내에서 Swagger 적용을 위한 설정이나 절차가 어떻게 되는지 자세히 알려주시면 감사하겠습니다.
감사합니다.
현재 egovframe-common-components-msa-krds.zip 파일을 사용하여 공통컴포넌트 26종을 KRDS 및 MSA 환경에 적용하고 있습니다.
이와 관련하여 Swagger 적용 방법에 대해 문의 드립니다.
Swagger를 통해 API 문서화를 적용하려고 하는데, 해당 배포 파일 내에서 Swagger 적용을 위한 설정이나 절차가 어떻게 되는지 자세히 알려주시면 감사하겠습니다.
감사합니다.
환경정보
-
- OS 정보 : Window 11
- 표준프레임워크 버전 : 4.3
- JDK(JRE) 정보 : 17.0.2
- WAS 정보 : tomcat
- DB 정보 : mariaDB
- 기타 환경 정보 :
A
안녕하세요
표준프레임워크센터입니다.
MSA-KRDS의 OpenSearch 프로젝트에서
Swagger에 대한 설정을 확인하실 수 있습니다.
추가적으로 여러개의 프로젝트에 Swagger를 적용하고자 하시는 경우
egovframe-msa-edu Repository에서 apigateway 프로젝트의 OpenApiDocConfig 클래스에
Swaager 관련 설정이 포함되어 있으므로 해당 코드를 참조하실 수 있습니다.
해당 클래스에서 Swagger 에 포함될 프로젝트는
apigateway 의 application.yml 에 설정한 route 정보 중
아이디가 [.*-service] 로 구성한 프로젝트로
구분하고 있으므로 이를 참고하여
구성하시기 바랍니다.
egovframe-msa-edu 참조 URL
https://github.com/eGovFramework/egovframe-msa-edu
감사합니다.
표준프레임워크센터입니다.
MSA-KRDS의 OpenSearch 프로젝트에서
Swagger에 대한 설정을 확인하실 수 있습니다.
추가적으로 여러개의 프로젝트에 Swagger를 적용하고자 하시는 경우
egovframe-msa-edu Repository에서 apigateway 프로젝트의 OpenApiDocConfig 클래스에
Swaager 관련 설정이 포함되어 있으므로 해당 코드를 참조하실 수 있습니다.
해당 클래스에서 Swagger 에 포함될 프로젝트는
apigateway 의 application.yml 에 설정한 route 정보 중
아이디가 [.*-service] 로 구성한 프로젝트로
구분하고 있으므로 이를 참고하여
구성하시기 바랍니다.
egovframe-msa-edu 참조 URL
https://github.com/eGovFramework/egovframe-msa-edu
감사합니다.
