使用 Python 管理 Azure API Center 的 API 资产与治理

通过集成 Azure API Center Management SDK for Python，开发者可以自动化管理组织内的 API 库存、定义 API 生命周期阶段并实施统一的治理标准。

为什么需要这个技能

在大型企业级开发中，API 的数量往往呈爆炸式增长，导致出现“影子 API”或版本混乱的情况。手动在 Azure 门户中登记每个 API 极其低效且难以维护。

通过 Python SDK，你可以将 API 的注册、版本控制和部署跟踪集成到 CI/CD 流水线中。这意味着每当一个新版本的 API 发布时，API Center 能够自动更新其元数据和定义，确保组织内的 API 目录始终是实时且准确的。

适用场景

• 自动化 API 目录：将 API 注册过程集成到构建脚本中。
• 治理标准化：通过代码定义自定义元数据架构（如数据分类级别），强制执行统一的治理标准。
• 生命周期跟踪：自动更新 API 从 Beta 到 Production 的阶段状态。
• 多环境映射：追踪特定 API 版本在生产、测试等不同环境中的部署情况。

核心工作流

1. 环境初始化：安装 azure-mgmt-apicenter 和 azure-identity 库，并配置 AZURE_SUBSCRIPTION_ID 环境变量。
2. 客户端认证：使用 DefaultAzureCredential 构建 ApiCenterMgmtClient 实例，实现无密码的安全访问。
3. 资源构建：
   • 创建或更新 API Center 服务实例。
   • 在指定工作区（Workspace）中注册 API 及其版本。
   • 导入 OpenAPI 规范（Specification）以定义 API 行为。
4. 治理与部署：
   • 定义 MetadataSchema 来规范 API 的元数据标签。
   • 创建 Environment 和 Deployment 记录，建立 API 定义与实际运行运行时（Runtime）的映射关系。

# 快速示例：注册一个 API 并定义版本
from azure.identity import DefaultAzureCredential
from azure.mgmt.apicenter import ApiCenterMgmtClient
from azure.mgmt.apicenter.models import Api, ApiKind, LifecycleStage, ApiVersion
import os

client = ApiCenterMgmtClient(
    credential=DefaultAzureCredential(),
    subscription_id=os.environ["AZURE_SUBSCRIPTION_ID"]
)

# 注册 API
api = client.apis.create_or_update(
    resource_group_name="my-resource-group",
    service_name="my-api-center",
    workspace_name="default",
    api_name="my-api",
    resource=Api(
        title="My API",
        kind=ApiKind.REST,
        lifecycle_stage=LifecycleStage.PRODUCTION
    )
)

# 创建版本
version = client.api_versions.create_or_update(
    resource_group_name="my-resource-group",
    service_name="my-api-center",
    workspace_name="default",
    api_name="my-api",
    version_name="v1",
    resource=ApiVersion(title="Version 1.0", lifecycle_stage=LifecycleStage.PRODUCTION)
)

下载和安装

下载 azure-mgmt-apicenter-py 中文版 Skill ZIP

解压后将目录放入你的 AI 工具 skills 文件夹，重启工具后即可使用。具体路径参考内附的 USAGE.zh.md。

你可能还需要

暂无推荐