Phiên bản: Latest(v3.0) 🔥

API Search/Design Feature

경로: APIM Console > 좌측 사이드메뉴 > API 관리 > API명 클릭 > API 상세 > API 배포
Swagger 미등록 시 선행 작업
1. 위 Swagger 관리 단계에서 Swagger 가져오기 Path를 설정합니다
2. API 상세 화면으로 돌아와 Swagger 가져오기 후 Swagger 저장하기를 클릭하여 저장합니다
배포: API 상세 화면에서 배포를 진행합니다.

경로: APIM Console > 좌측 사이드메뉴 > API Search
시나리오: 개발할 API Endpoint 존재 여부를 확인하고 수정/신규 개발을 결정합니다
- Path, Method, Request/Response body field, Summary, Description 등을 검색합니다
- 이미 필요한 Endpoint가 있을 경우: 별도 개발 없이 기존 API를 활용합니다
- 일부 필드 추가 등 경미한 변경이 필요한 경우: 기존 Endpoint 실행 테스트 후 History를 저장·공유하여 변경 필요사항을 개발자에게 전달합니다
- 전혀 없는 경우: 신규 API Endpoint를 설계/개발합니다
주의사항
- ⚠️ API Search를 위해서 APIM에 Swagger를 등록 관리해야 합니다.
- ⚠️ API Search는 Swagger 정보를 기반으로 결과가 조회됩니다.

경로: APIM Console > 좌측 사이드메뉴 > API Docs Validation
시나리오: 신규 개발 또는 기존 API 변경 시 "API 형식 검증"으로 문서 표준 준수를 검증합니다
1. 로컬/개발 환경에서 프로그램이 생성한 Swagger JSON을 추출합니다
2. APIM의 "API 형식 검증"에 업로드/입력하여 검증을 실행합니다
3. 결과를 확인하고, 표준 미준수 발생 시, 프로그램을 수정하고, 최종적으로 검증을 통과시킵니다
주의사항
- ⚠️ 검증계 환경에서 검증을 통과시킨 후, 운영계 배포를 진행하도록 합니다.
- ⚠️ 이로써 운영계 환경에서는 표준화된 문서 형태로 등록/배포/관리될 수 있게 됩니다.