본문으로 건너뛰기

스테이지 생성 및 관리

카카오클라우드 API Gateway는 Stage 별로 {uuid}.api-service.kakaocloud-kr-gov.com 형식의 퍼블릭 도메인을 자동 생성하여 제공합니다. 사용자는 각 스테이지의 엔드포인트에 대한 인증 및 인가, 경로 설정을 할 수 있습니다. 또한, 사용자 정의 도메인을 이용하여 사용자가 원하는 도메인을 설정하는 것도 가능합니다.

Stage 생성​

신규 스테이지를 생성할 수 있습니다.

  1. 카카오클라우드 콘솔에서 Beyond Networking Service > API Gateway 메뉴로 이동합니다.

  2. Stage 메뉴를 클릭한 후, [Stage 만들기] 버튼을 클릭합니다.

  3. Stage 생성 화면에서 스테이지의 상세 정보를 입력하고 [생성] 버튼을 클릭합니다.

    구분설명
    Service이 스테이지가 생성될 서비스를 선택
    Stage 이름스테이지의 이름 지정
    Auth Type2가지 유형을 제공합니다.
    - None: 인증 방식을 선택하지 않음
    - API Key: API Key 유형을 선택하며, x-api-key 요청 헤더에 API 키 값을 포함해 요청을 전달해야 합니다. 또한, 접근 권한 부여를 위해 규칙을 추가적으로 적용해야 합니다.
    RuleAuth Type을 API Key 유형 선택 시 설정해야 하는 인가 규칙입니다.
    - None: Auth Type을 None 선택 시 자동 선택
    - Custom Rule: API Key 유형 선택 시 자동 선택
    Custom Domain사용자 정의 도메인을 이용할 경우, 사용 상태를 선택합니다.
    - Key 파일 등록: 인증서 키 파일을 업로드
    - CRT 파일 등록: CRT 파일을 업로드 및 등록

Stage 조회​

현재 생성된 스테이지 목록을 확인할 수 있습니다.

  1. 카카오클라우드 콘솔에서 Beyond Networking Stage > API Gateway 메뉴로 이동합니다.

  2. Stage 메뉴를 클릭한 후, 현재 생성된 스테이지 목록을 확인합니다.

    구분설명
    Stage생성되어 있는 스테이지의 이름
    Service해당 스테이지가 속한 서비스의 이름
    Stage 설명해당 스테이지에 대한 설명을 기술
    API Gateway Domain해당 스테이지의 주소
    Custom Domain스테이지 설정에서 사용자 정의 도메인이 노출되는 항목
    Auth TypeNone 또는 API Key 중 표시
    Rule선택된 Auth Type에 맞춰 표시
    생성일해당 스테이지가 생성된 일시
    [더 보기] 아이콘Stage 수정: 스테이지의 설명, Auth Type, Rule Type, Custom Domain 선택을 변경
    Stage 삭제: 스테이지를 삭제

  3. 상세 정보를 확인할 스테이지를 클릭한 후, 해당 스테이지의 상세 페이지에서 정보를 확인합니다.

상세 조회 정보는 크게 API Path, API Key, Rule 탭으로 구분됩니다.

API Path 탭은 다시 3개의 하위 탭으로 구성되며, 각각 세부 정보, Method, 하위 Path탭이 이에 해당됩니다.

세부 정보 탭​

세부 정보 탭에서는 API 경로에 대한 각종 상세 정보를 확인할 수 있습니다.

구분설명
API Path생성된 API 경로
API Path ID해당 API 경로의 ID
Path TypeAPI 경로의 유형을 의미하며 3가지 유형이 있습니다.
- 기본: 경로 전체를 직접 표시(예: /api/v1/mock)
Path Parameter: 접근하는 고유한 정보를 변수화하여 지정해둔 매개변수를 경로에 표시(예: /api/v1/{serviceId})
Proxy Path: {proxy+} 경로 변수 표시
Websocketwss 통신 사용 여부를 표시
Request Custom Header 추가Request Custom Header에 대한 추가 여부를 표시
Request Custom Header 삭제Request Custom Header에 대한 삭제 여부를 표시
Response Custom Header 추가Response Custom Header에 대한 추가 여부를 표시
Response Custom Header 삭제Response Custom Header에 대한 삭제 여부를 표시
CORSCross-Origin Resource Sharing(CORS) 사용 여부를 표시
생성일해당 API 경로가 생성된 일시
수정일최종적으로 해당 API 경로가 수정된 일시
생성자해당 API 경로를 생성한 계정의 이메일 정보

Method 탭​

  • 생성된 메서드 목록을 확인 가능하며, [Method 추가] 버튼을 클릭하여 메서드를 추가할 수 있습니다.
Method 목록 조회​

아래의 상세 내용들을 확인 가능합니다.

구분설명
Method지정한 메서드를 표시
- GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS 중 하나 이상 선택
Host업스트림의 엔드포인트 주소
Path설정된 경로를 표시
Port업스트림의 포트 정보를 표시
Protocol업스트림 프로토콜 정보를 표시
Timeout설정된 만료 시간을 표시
[더 보기] 아이콘Method 설정: 해당 메서드의 설정을 수정 가능
Method 삭제: 해당 메서드를 삭제
Method 추가​
  • [Method 추가] 버튼을 클릭하여 메서드 지정 및 업스트림에 대한 프로토콜, 호스트, 경로, 포트 번호, 만료 시간 정보를 입력 후 [생성] 버튼을 클릭합니다.
Method 설정​
  • [더 보기] 아이콘을 클릭 후 [Method 설정]을 선택합니다. Protocol 유형(HTTP 또는 HTTPS) 및 호스트 정보, 업스트림에 대한 포트 및 만료 시간 정보를 수정할 수 있으며, 수정 후 [적용] 버튼을 클릭합니다.
Method 삭제​
  • [더 보기] 아이콘을 클릭 후 [Method 삭제]를 선택합니다. 팝업창에서 메서드를 입력하고, [삭제] 버튼을 클릭합니다.

하위 Path 탭​

  • 생성된 하위 경로 목록을 확인 가능하며, [하위 Path 추가] 버튼을 클릭하여 메서드를 추가할 수 있습니다.
하위 Path 목록 조회​

아래의 상세 내용들을 확인 가능합니다.

구분설명
Path상위 경로(/) 및 생성된 경로를 표시
Method해당 하위 경로에 지정된 메서드를 표시
Type경로 유형 3가지 유형 중 하나를 표시합니다.
- 기본: 경로 전체를 직접 표시하는 방식
Path Parameter: 매개변수를 경로에 표시하는 방식
Proxy Path: {proxy+}로 표시하는 방식
Proxy경로 유형이 프록시 유형으로 선택되었는지 여부를 표시
WebsocketWebsocket 사용 여부에 대한 설정 상태를 표시
CORSCORS 사용 여부에 대한 설정 상태를 표시
생성일해당 하위 경로가 생성된 일시
[더 보기] 아이콘Path 설정: 해당 하위 경로 설정을 수정 가능
Path 삭제: 해당 하위 경로를 삭제
하위 Path 추가​
  • [하위 Path 추가] 버튼을 클릭하여 경로 정보를 입력 후, 경로 유형, Websocket 사용 여부, 요청 및 응답 사용자 정의 헤더 삭제 사용 여부, CORS 사용 여부를 선택한 다음 [생성] 버튼을 클릭합니다.
하위 Path 설정​
  • [더 보기] 아이콘을 클릭 후 [Path 설정]을 선택합니다. 경로 정보, 경로 유형, Websocket 사용 여부, 요청 및 응답 사용자 정의 헤더 삭제 사용 여부, CORS 사용 여부를 수정할 수 있으며, 수정 후 [적용] 버튼을 클릭합니다.
하위 Path 삭제​
  • [더 보기] 아이콘을 클릭 후 [Path 삭제]를 선택합니다. 팝업창에서 경로명을 입력하고, [삭제] 버튼을 클릭합니다.

Stage 수정​

스테이지의 설명, Auth Type, Rule Type, Custom Domain 설정을 변경할 수 있습니다.

  1. 카카오클라우드 콘솔에서 Beyond Networking Stage > API Gateway 메뉴로 이동합니다.

  2. Stage 메뉴를 클릭한 후, 수정할 스테이지의 [더 보기] 아이콘 > Stage 수정을 선택합니다.

  3. Stage 수정 팝업창에서 각 사항들을 수정한 후, [적용] 버튼을 클릭합니다.

    구분설명
    Service이 스테이지가 속한 서비스의 이름 표시
    Stage스테이지 이름 표시
    Stage 설명해당 스테이지에 대한 설명을 수정
    Auth TypeNone 또는 API Key 중 변경
    Rule선택된 Auth Type에 맞춰 자동 변경
    Custom Domain사용 또는 미사용 변경 가능

Stage 삭제​

더 이상 사용하지 않는 스테이지를 삭제할 수 있습니다.

  1. 카카오클라우드 콘솔에서 Beyond Networking Stage > API Gateway 메뉴로 이동합니다.
  2. Stage 메뉴를 클릭한 후, 삭제할 스테이지의 [더 보기] 아이콘 > Stage 삭제를 선택합니다.
  3. Stage 삭제 팝업창에서 스테이지 이름을 입력하고, [삭제] 버튼을 클릭합니다.