API Creation / Deployment / Invocation

개요

이 튜토리얼은 APIM에서의 전체 API 생애 주기를 보여줍니다 - 새로운 API 정의를 생성하고, 이를 게이트웨이에 배포하며, HTTP 요청을 통해 호출을 확인하는 과정입니다. 이 과정에는 요청 경로 설정, 배포 대상 선택, 배포 후 API 응답 테스트와 같은 일반적인 실제 구성들이 포함됩니다.

전제 조건

다음 사항이 준비되어 있는지 확인하세요:

게이트웨이가 이미 존재하고 활성화되어 있어야 합니다 (예: gateway-prod-mj)
개발자 또는 관리자 권한으로 APIM 콘솔에 접근할 수 있어야 합니다
프로젝트가 이미 생성되어 있어야 합니다 (pj-test-01)
최소한 하나의 게이트웨이 URL이 등록되어 있어야 합니다 (예: https://api.sksample.co.kr/gateway-test-01)

단계별 튜토리얼

단계 1. 새로운 API 생성

API 관리로 이동합니다. API 생성 버튼을 클릭합니다.

필드	예시
API 이름	user-service-api
기본 경로	/user-service
설명	사용자 등록 및 로그인 처리
가시성	비공개
태그	user, auth, v1

버튼을 클릭하여 버전 정의로 진행합니다.

단계 2. API 버전 정의

필드	예시
버전 이름	v1.0
대상 URL (백엔드)	https://backend.sksample.co.kr/user
게이트웨이	gateway-prod-mj
요청 방법	GET, POST, PUT, DELETE
기본 경로 제거	활성화 (백엔드 형식에 따라 선택 사항)

저장 및 배포 버튼을 클릭합니다.

단계 3. API를 게이트웨이에 배포

API가 저장되면:

API 구성 화면으로 이동합니다
정보를 검토하고 확인합니다
배포 버튼을 클릭합니다 (버전 v1.0 선택)
상태가 배포됨으로 업데이트될 때까지 기다립니다. 수정 후 재배포할 수 있습니다.

단계 4. 배포된 API 테스트

API를 테스트하려면 모든 HTTP 클라이언트(Postman, curl, 브라우저 등)를 사용할 수 있습니다.

curl을 사용한 예제 테스트:

curl -X GET "[https://api.sksample.co.kr/gateway-test-01/user-service/v1/status](https://api.sksample.co.kr/gateway-test-01/user-service/v1/status)"

예상 응답:

{
"status": "ok",
"service": "user-service",
"version": "v1.0"
}

일반적인 문제 및 문제 해결

Issue	Cause	Solution
404 찾을 수 없음	잘못된 경로	BasePath 및 RoutePath 설정을 다시 확인하세요
SSL 오류	게이트웨이에 유효한 인증서가 없음	HTTPS가 활성화되어 있고 TLS 인증서가 유효한지 확인하세요
시간 초과	백엔드 대상 URL에 접근할 수 없음	게이트웨이에서 백엔드로의 DNS 및 네트워크 접근을 확인하세요
403 금지됨	API 키 필요	인증 정책이 활성화되어 있는지 확인하세요

모범 사례

BasePath 및 RoutePath를 깔끔하고 버전 관리하세요 (예: /api-name/v1)
적절한 TLS 및 기본 URL 구성이 있는 검증된 게이트웨이에만 배포하세요
소비자와 공유하기 전에 curl 또는 Postman으로 테스트하세요
논리적 그룹화를 위해 태그를 사용하세요 (예: public, internal, v2)
롤백 및 반복을 위해 버전 기록을 유지하세요

개요​

전제 조건​

단계별 튜토리얼​

단계 1. 새로운 API 생성​

단계 2. API 버전 정의​

단계 3. API를 게이트웨이에 배포​

단계 4. 배포된 API 테스트​

일반적인 문제 및 문제 해결​

모범 사례​

개요