page no. 114819146
- 기능 설명
- Swagger UI는 생성된 OpenAPI 사양을 사용하여 서비스에 대한 정보를 제공하는 웹 기반 UI를 제공
- OpenAPI(이전 명칭: Swagger) 사양에서 자동 생성되며, 시각적 문서가 제공되어 백엔드 구현 및 클라이언트 측 사용이 용이
- AUD7 플랫폼에서 제공하는 Swagger UI는 기본 미 오픈되어 적용되며 설정을 통해 개발 환경이나 필요 시 해당 기능 사용 가능
- 사용 방법
- {AUD7 플랫폼 서버경로}/WEB-INF/classes/framework/service/service_api.properties에서 matrix.swagger.enable 값을 true로 변경
- AUD7 플랫폼 서버 재기동한다.
- 브라우저에서 {AUD 서버 주소}/swagger-ui/index.html 을 호출하여 OpenAPI 테스트 시각화 화면을 호출한다.
참고 사항
- matrix.swagger.enable = false 인 상태에서 Swagger ui 호출 시에는 403 에러 페이지 호출됩니다.
- 현재 각 API에 대한 기능 정의 문서 업데이트 중이며 업데이트 완료 시 확인하실 수 있습니다.
- 인증이 되지 않은 사용자가 호출 시에는 실행에 대한 결과를 얻을 수 없습니다.
| 기능 정보 |
|
|
|
|
|
|
|
|---|---|---|---|---|---|---|---|
| 시작 버전 정보 |
| ||||||
샘플 정보
- 샘플 URL : https://rnd.bimatrix.co.kr/aud7/swagger-ui/index.html
- 사용 방법
1. 테스트 할 Open Rest API를 확인하여 해당 API를 클릭한다