API Management
API 관리 소개
API 관리는 APIM 시스템 내에서 API를 생성, 구성, 테스트, 배포 및 모니터링하는 기능을 제공합니다. 이는 사용자가 API를 효율적으로 관리할 수 있는 중앙 집중식 인터페이스 역할을 합니다.
주요 기능
API Creation & Initial Configuration: 사용자는 필요한 구성으로 새로운 API를 생성할 수 있습니다.
API Post-Creation Configuration:- API Policies Applying: 사용자는 인증, 보안 및 트래픽 제어를 위한 정책을 적용할 수 있습니다.
- Canary Config: API 버전의 제어된 롤아웃을 허용합니다.
- API Documentation: Swagger 문서를 가져오고 편집할 수 있습니다.
- API Testing: 배포 전에 요청 방법, 헤더 및 매개변수를 사용하여 API를 테스트할 수 있습니다.
- API Deployment: 사용자는 API를 게시하여 외부에서 접근할 수 있도록 합니다.
- API Modification and Deletion: API 사용에 대한 통찰력을 제공하고 업데이트를 가능하게 합니다.
API 관리 접근
사용자는 사이드바 메뉴에서 API Management로 이동할 수 있습니다.
이 화면은 모든 API에 대한 개요를 제공하며, 필터링, 검색 및 API 관리를 위한 옵션이 있습니다.
API 관리 화면의 기능
Project Selection: 프로젝트를 선택하여 해당 API를 볼 수 있습니다.
API Data Table: 프로젝트 내의 모든 API 목록을 표시합니다. 페이지 매김이 지원됩니다.
Search Bar: 키워드를 사용하여 API를 검색할 수 있습니다.
Create API Button: API 생성 인터페이스에 접근합니다.
API and Gateway Tag Filter: 게이트웨이 태그 또는 API 태그를 기반으로 API를 필터링합니다.
API 생성 및 초기 구성
사용자는 API 관리 화면에서 CREATE AN API를 클릭하여 새 API를 생성할 수 있습니다.
단계:
- Select Project: 드롭다운 목록에서 프로젝트를 선택합니다.
- Configure API Details: 아래의 API 초기 구성 세부정보를 참조합니다.
- Save API: 생성을 완료하려면 API STORAGE을 클릭하거나 중단하려면 CANCELLATION을 클릭합니다.
API 초기 구성 세부정보
| Field Name | Purpose | Input Notes | Mandatory |
|---|---|---|---|
| API 이름 | 고유한 API 식별자입니다. | 영어 문자, 숫자, 공백, 밑줄 ‘_’, 또는 이중 콤마 ‘:’로 구성됩니다. | 예 |
| API 설명 | API에 대한 추가 세부정보입니다. | 간단한 설명입니다. | 아니요 |
| API 태그 | API 필터링/검색에 사용됩니다. | Enter로 태그를 구분합니다. | 아니요 |
| API 유형 | API의 통신 유형을 정의하며, API가 백엔드에 연결되는 방식을 설명합니다. | HTTP, WebSocket, AWS Lambda 중에서 선택합니다. API 유형에 대한 자세한 지침은 설정을 참조하십시오. | 예 |
| 프로토콜 | API의 보안 프로토콜을 지정합니다. | HTTP 또는 HTTPS 중에서 선택합니다. HTTPS가 선택된 경우 SSL 인증서가 필요합니다. | 예 |
| HTTP 메서드 | 허용되는 요청 메서드를 결정합니다. | GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS, TRACE, CONNECT 중에서 선택합니다. 여러 메서드를 선택할 수 있습니다. | 예 |
| 게이트웨이 | API에 접근하는 게이트웨이를 지정합니다. | 기존 게이트웨이를 선택합니다. API는 게이트웨이에 연결되어야 합니다. | 예 |
| 게이트웨이 URL | API의 공개-facing URL입니다. | 선택한 게이트웨이를 기반으로 자동으로 설정되며, 수동으로 편집할 수 없습니다. 자세한 내용은 사용자 가이드/APIM 콘솔/게이트웨이 관리에서 참조하십시오. | 예 |
| 게이트웨이 URL 기본 경로 | 클라이언트 요청을 위한 API 경로를 정의합니다. | 경로를 입력합니다 (예: /order). 게이트웨이 URL과 결합하여 전체 API URL을 형성합니다. | 아니요 |
| 기본 경로 | 요청을 백엔드로 전달하기 전에 제거될 경로를 설정합니다. | /service와 같은 값을 입력합니다. Strip Path 토글과 함께 작동합니다. | 예 |
| 경로 제거 | 백엔드로 전달하기 전에 기본 경로를 제거합니다. | 켜기 또는 끄기. 활성화되면 /service가 백엔드에 도달하기 전에 요청에서 제거됩니다. | 예 |
| API URL | 최종 클라이언트-facing API URL입니다. | 게이트웨이 URL과 기본 경로를 결합하여 자동으로 생성됩니다. | 예 |
| 백엔드 URL | 게이트웨이에 의해 프록시될 백엔드 서비스의 주소입니다. | 전체 URL을 입력합니다. HTTP 기반 API에 필요한 필드입니다. 더 자세한 지침은 API 유형 설정을 참조하십시오. | 예 |
| 스웨거 가져오기 경로 | 백엔드에서 스웨거 JSON 문서를 가져옵니다. | 스웨거 경로를 입력합니다 (예: /v2/api-docs). 자동으로 백엔드 URL에 추가됩니다. | 예 |
| 개발자 포털 게시 | API가 개발자 포털에 나열되어야 하는지 여부를 결정합니다. | 체크박스. 체크하면 API가 개발자 포털에 표시되며 개발자 포털에서 제품으로 구성할 수 있습니다. 제품으로 구성하는 방법에 대한 자세한 정보는 개발자 포털 가이드를 참조하십시오. | 아니요 |
API 유형 설정
사용자가 API 유형으로 HTTP 또는 WebSocket을 선택하면, 백엔드 URL에 대한 특정 URL 형식을 따라야 합니다.
Allowed Backend URL Formats:- http://domain.com/
- http://domain.com
- https://domain.com
- http://sub3.sub2.sub1.domain.com
- http://domain.com/path1
- http://domain.com/path1/path2/path3
- http://domain.com:8081
- http://sub.domain.com:8081/path
사용자가 API 유형으로 AWS Lambda 함수 통합을 선택하면, API를 AWS Lambda와 연결하기 위해 AWS 자격 증명을 구성해야 합니다.
Additional Required Fields for AWS Lambda:- Lambda Name: AWS Lambda 함수 이름을 입력하세요.
- AWS Region: Lambda 함수가 배포된 AWS 리전을 입력하세요.
API 생성 예시:
API가 다음과 같이 설정된 경우:
- API 유형: HTTP (https 프로토콜 사용)
- 게이트웨이 URL: https://your.domain.com
- 기본 경로: /myservice
- 백엔드 URL: http://backend.com/backend
- Swagger 가져오기 경로: /v2/api-docs
클라이언트 요청을 위한 최종 API URL은 다음과 같습니다: https://your.domain.com/myservice
Swagger 문서는 다음에서 가져옵니다: http://backend.com/backend/v2/api-docs
예를 들어, 클라이언트가 https://your.domain.com/myservice/v1/apis/를 호출하면 궁극적으로 http://backend.com/backend/v1/apis/ 경로로 프록시됩니다.
API 생성 후 구성
API가 생성되면 사용자는 API 세부 정보 화면으로 이동하여 생성 후 구성을 관리하거나 API를 삭제할 수 있습니다.
Available Configurations:- API Policies Applying: 인바운드 및 아웃바운드 API 정책을 설정합니다.
- Canary Config: 버전 기반 배포를 구성합니다.
- API Documentation: Swagger 문서를 가져오거나 편집하거나 업데이트합니다.
- API Testing: 배포 전에 API 테스트를 실행합니다.
- API Deployment: 외부 액세스를 위해 API를 배포합니다.
- Edit API Frontend & Backend: API URL, 기본 경로 및 백엔드 URL을 수정합니다.
- API Deletion: API를 삭제합니다.
API 정책 적용
사용자는 API 동작을 제어하기 위해 정책을 설정할 수 있습니다. 정책은 다음과 같이 나뉩니다:
- Inbound: 백엔드에 도달하기 전에 요청을 수정합니다 (예: 헤더 변환, IP 제한).
- Outbound: 클라이언트에 도달하기 전에 응답을 수정합니다 (예: 로깅, 헤더 추가).
사용자는 정책을 추가하거나 제거하고 배포 전에 설정을 구성할 수 있습니다.
Steps:- 정책 섹션의 Edit 아이콘을 클릭하여 API 정책 세부 정보 구성 화면에 접근합니다.
- Not Applicable 섹션에서 정책을 추가하거나 적용된 정책을 제거합니다.
- 정책 이름을 클릭하여 정책 설정을 구성합니다. 각 정책에 대한 구성 방법에 대한 자세한 내용은 사용자 가이드/APIM 콘솔/API 정책을 참조하십시오.
- STORING을 클릭하여 변경 사항을 저장합니다.
정책은 개별적으로 저장해야 하며 API 배포 후에만 적용됩니다.
카나리 구성
카나리 구성은 제어된 API 버전 롤아웃을 허용합니다. 사용자는 카나리 구성 토글을 통해 활성화할 수 있습니다.
Steps:- 카나리 구성 ON을(를) 전환합니다.
- 카나리 구성 설정:
| Field Name | Input Instructions |
|---|---|
| 백엔드: URL | (ver) 변수를 포함한 백엔드 URL. 예: http://backend-url-(ver):8081 |
| 기준선: 버전 | 기준선의 버전. |
| 기준선: 링크 | 사용자가 '기준선: 버전' 필드에 입력할 때 링크에 버전을 자동으로 업데이트합니다. |
| 기준선: 가중치 (%) | 입력 숫자. “기준선: 가중치 (%)” 필드와 “카나리: 가중치 (%)”의 총합은 100입니다. |
| 카나리: 버전 | 카나리의 버전 |
| 카나리: 링크 | 사용자가 “카나리: 버전” 필드에 입력할 때 링크에 버전을 자동으로 업데이트합니다. |
| 카나리: 비율 (%) | 입력 숫자. “기준선: 비율 (%)” 필드와 “기준선: 비율 (%)”의 총합은 100입니다. |
- 변경 사항을 적용하려면 SAVE를 클릭하세요.
사용자는 나중에 API 관리 또는 API 세부정보 화면을 통해 카나리 구성을 편집할 수 있습니다.
API 문서화 (Swagger)
사용자는 Swagger 문서를 가져오거나 수동으로 편집할 수 있습니다.
Steps:- Swagger 검색 경로를 설정하세요 (예: /v3/api-docs).
- 문서를 가져오려면 GET SWAGGER를 클릭하세요.
- 필요시 Swagger Editor에서 Swagger JSON을 편집하세요.
- 변경 사항을 저장하려면 SAVE SWAGGER를 클릭하세요.
Swagger 문서는 API와 함께 배포되며 사이드바의 API Document에서 접근할 수 있습니다.
API 테스트
사용자는 배포 전에 API를 테스트할 수 있습니다.
Features:- Supported Methods: GET, POST, PUT, DELETE, HEAD, OPTIONS, PATCH.
- Request Parameters: 경로 (/path/(key1)), 헤더, 쿼리 매개변수, 본문.
- Response Analysis: 상태, 헤더 및 응답 본문을 보기.
테스트를 시작하려면 TEST API REQUESTS을 클릭하세요.
API 배포
API는 외부 접근을 위해 배포되어야 합니다.
Steps:- API DEPLOYMENT를 클릭하세요.
- 배포 버전 설명을 입력하세요.
- 배포하려면 CONFIRMATION을 클릭하세요.
최신 배포된 버전만 외부에서 접근할 수 있습니다.
API 프론트엔드 및 백엔드 편집
사용자는 프론트엔드/백엔드 구성에서 API 설정을 편집할 수 있습니다.
API 삭제
사용자는 다음을 통해 API를 삭제할 수 있습니다:
- Trash icon API 세부 정보 화면에서.
- Cross icon API 관리 화면의 Action 아래에서.
삭제된 API는 복원할 수 없습니다.
