Azure API Center란 무엇입니까?
Azure API Center는 모든 조직 API가 모여 있는 구조화된 중앙 집중식 리포지토리를 제공하여 통합된 추적, 검색, 재사용, 관리를 가능하게 하는 Azure의 새로운 서비스입니다. API Center는 메타데이터 또는 API 관련 정보와 함께 API의 유형, 개발 수명 주기 단계 또는 API 런타임의 배포 위치에 관계없이 모든 API를 통합하고 구성하는 보안 솔루션입니다.
API Center의 이점
| 고객 문제 | API Center의 이점 |
|---|---|
| 불편한 API 검색 기능 및 재사용 | API 검색 및 사용의 용이성. API 관리자는 Azure Portal에서 모든 API가 포함된 전체 인벤토리를 볼 수 있습니다. API 소비자는 웹 기반 API Center 포털을 사용하여 API를 검색 및 사용하거나 Visual Studio Code용 API Center 확장을 사용하여 API를 구축, 검색, 사용할 수 있습니다. |
| 섀도, 관리되지 않는 API | 중앙 집중식 API 인벤토리. API Center를 사용하면 조직에서 다양한 팀과 부서의 API를 한 곳에 모은 중앙 리포지토리를 구축하여 모든 API에 대한 신뢰할 수 있는 통합 정보 소스로 사용할 수 있습니다. |
| 잠재적인 보안 위협 | API 거버넌스의 용이성. API를 한 위치에 통합하면 API 플랫폼 팀이 이러한 API를 관리하여 조직 보안 정책을 적용하는 것이 더 쉬워집니다. |
| 일관되지 않은 API 설계 | 자동화된 API 설계 적합성 검사. API Center는 관리자가 모든 API에 설계 표준을 적용할 수 있도록 하며, 정의된 스타일 가이드와 대조해 API 검사를 수행하고 API Center에서 확인 가능한 API 적합성 보고서를 생성하는 린팅 워크플로를 구현합니다. |
API 에코시스템 역할 및 책임
조직의 API 에코시스템은 성공적인 운영에 필수적인 다양한 책임을 지닌 다양한 역할로 구성되는 경우가 많습니다. 몇 가지 역할에 대해 자세히 살펴보겠습니다.
API 제작자 - 다음과 같은 주요 책임을 갖는 개별 개발자 또는 팀일 수 있습니다.
- 시스템 사양 및 요구 사항 통합
- 정의된 목표에 맞는 API 아키텍처 설계
- API의 개발, 보안 유지, 게시
- 테스트를 통해 API가 기능 및 성능 요구 사항을 모두 충족하도록 보장
- API 문서화
- 버전 및 업데이트 관리를 비롯한 API 유지 관리 작업
API 제작자는 모범 사례, 보안 및 규정 준수 정책, 조직의 API 표준을 준수하여 일관성을 유지하려고 노력합니다. 또한 조직 내 이전 팀/다른 팀의 작업과 중복되지 않도록 해야 합니다.
API 소비자 - 다음과 같은 내부 또는 외부 API 사용자일 수 있습니다.
- 내부 비즈니스 워크플로 및 서비스에서 프라이빗 API 사용(내부 소비자)
- 전략적 비즈니스 파트너십에 통합하기 위해 제한된 API 엔드포인트 사용(파트너 소비자)
- 조직 제공 서비스를 사용하는 외부 시스템을 구축하기 위해 공개적으로 사용 가능한 API 사용(제3자 소비자)
API 소비자는 중복 작업을 방지하고 중요한 개발 리소스를 낭비하지 않도록 워크로드에 가장 적합한 API를 빠르게 찾아야 합니다. 이를 위해 양질의 사용하기 쉬운 문서를 받아 API가 각 요구 사항을 해결하고 애플리케이션에 원활하게 통합될 수 있는지 검증하는 것이 중요합니다.
API 플랫폼 팀 - API 플랫폼 엔지니어는 조직을 위해 확장 가능하고 안전하며 성능이 뛰어난 API 아키텍처를 만들고 유지하는 데 관심을 두고 있습니다. 이들은 다음과 같은 작업을 수행합니다.
- API 아키텍처 디자인 및 개발
- 조직 전반에 걸쳐 API 모범 사례와 디자인 표준 설정 및 적용
- 실행 가능한 인사이트를 생성하기 위해 모니터링, 분석, 보고 적용
- 인증, 권한 부여, 암호화 프로토콜을 통해 API 보안 구현 및 관리
- 제품 관리자, API 생산자, 소비자 간의 협업과 피드백을 지원하여 API 전략 조정
- 내부 및 외부 모두에서 API 통합 및 문제 해결 지원
Contoso의 API 플랫폼 엔지니어는 협력하여 조직에서 API의 무분별한 확장을 방지하는 채택하기 쉬운 전략을 롤아웃합니다.
API Center 작동 방식
조직의 API 플랫폼 엔지니어는 API 버전, 정의 등과 같은 기타 메타데이터와 함께 모든 API(내부 및 외부 모두)의 중앙 집중식 리포지토리를 구성하는 빠르고 쉬운 방법이 필요합니다. API Center를 사용하면 다양한 API 관리 솔루션에서 호스트 및 관리되는 API 카탈로그를 만들고 다양한 설계, 개발, 테스트, 프로덕션 수명 주기에 걸쳐 관리할 수 있습니다.
Azure API Center의 기능
API 인벤토리
API Center는 조직 전체에서 구축되고 사용되는 모든 API를 한데 모은 완전한 최신 인벤토리를 구축하는 것에 기초를 둡니다. 이 인벤토리는 대규모 API 거버넌스, 검색, 사용을 가능하게 하는 데 핵심적인 요소입니다.
API Center를 사용하면 다음 사항과 관계없이 인벤토리에 API를 추가할 수 있습니다.
- API 기술 및 언어: ASP.NET Core Web API, Express, FastAPI, 서버리스 API 등
- API 유형: REST, GraphQL, SOAP, gRPC, WebSocket, WebHook 등
- 런타임 환경: Kubernetes 클러스터, 웹앱, API Management, Apigee API 관리, Azure Functions 등
API 거버넌스
이제 완전한 API 인벤토리를 사용하여 이러한 API가 일관되고 표준화되며 사용 가능하고 안전하도록 보장하는 방법을 살펴보겠습니다. API 거버넌스는 모든 조직 API에서 대규모로 표준, 정책, 프로세스를 정의하고 적용하는 관행이라고 정의할 수 있습니다.
API Center의 이 기능은 버전, 소유자, 수명 주기와 같은 메타데이터를 사용하여 API 추적을 간소화하고 규정 준수 검토, 호환성이 손상되는 변경 사항 감지 등과 같은 프로세스 추적 또한 간소화합니다.
API Center는 등록된 API가 조직의 스타일 규칙을 준수하도록 하고 API에 대한 분석 기능을 제공하는 Spectral JSON/YAML Linter를 사용하여 구현되는 린팅을 지원하는 API 설계 거버넌스 관련 도구도 제공합니다. 조직에서 이 기능을 사용하도록 설정하면 API Center에서 볼 수 있는 규정 준수 보고서를 생성하여 오류 및 불일치를 조기에 감지할 수 있습니다.
API 플랫폼 작업은 개발자 동의가 있을 때 가장 성공적입니다. Visual Studio Code용 API Center 확장은 API가 처음부터 올바른 방식으로 구축되도록 호환성이 손상되는 변경 사항 감지 및 API 설계 거버넌스를 지원하는 근본적인 API 거버넌스 기능을 제공합니다.
API 검색 및 사용
API Center는 Visual Studio Code와 같은 인기 있는 개발자 도구와 통합함으로써 전체 API 개발 수명 주기를 간소화하여 개발자 환경을 개선합니다. API Center 확장은 API 소비자가 기존 작업 방식을 벗어날 필요 없이 Visual Studio Code 내에서 바로 API를 검색, 시도, 사용할 수 있는 환경을 제공합니다. 또한 API Center는 API 소비자가 쉽게 문서를 탐색하고 API 카탈로그에서 API를 검색, 액세스, 사용할 수 있도록 설계된 익숙한 웹 기반 API Center 포털을 제공합니다.
다음 단원에서는 Azure Portal을 통하거나, 로컬에서 Azure CLI를 사용하거나, VS Code의 API Center 확장을 통해 API Center를 사용하여 API 인벤토리를 만들고 관리하는 방법을 알아봅니다.