关于通过自定义UI调用REST API配置API Management及自建APIM配置UI的实现方案与参考文档咨询

当然可以！完全可以通过自定义UI调用REST API来完成API Management的所有配置工作——APIM提供了一套完整的管理型REST API，Azure门户里能做的所有操作，几乎都能通过API调用实现，所以你自己开发UI的方案是完全可行的。

下面给你详细说下实现这个方案的步骤和关键要点：

一、核心前提：获取APIM管理API的调用权限 #

要调用APIM的管理API，你需要先获得合法的身份凭据，推荐使用**Azure AD服务主体（Service Principal）**来实现后台授权：

• 在Azure AD中创建一个服务主体，给它分配APIM实例的API Management Service Contributor角色（或者更细粒度的权限，比如针对用户、产品的特定操作权限）
• 保存服务主体的租户ID、客户端ID、客户端密钥，这些是获取访问令牌的关键信息

二、关键操作的API实现思路 #

你提到的创建订阅密钥、创建用户、将API添加至产品这些操作，都有对应的APIM管理API支持，核心操作的思路如下：

1. 创建用户 #

调用用户创建的PUT/POST端点，传入用户的基本信息（邮箱、姓名、显示名、密码等），API会返回创建后的用户ID，后续操作会用到这个ID。

2. 创建订阅密钥 #

订阅是关联用户和产品的桥梁，调用订阅创建端点时需要指定：

• 订阅的显示名称
• 关联的用户ID（来自创建用户的结果）
• 关联的产品ID（目标产品的标识符）
• 订阅的状态（比如active表示启用）
  API会自动生成主密钥和次密钥，你可以直接返回给UI展示。

3. 将API添加至产品 #

调用产品关联API的PUT端点，传入目标产品的ID和要添加的API ID，就能完成两者的关联。如果需要批量添加，也可以循环调用这个接口。

三、自定义UI的开发流程 #

1. 前端层：设计对应的操作界面，比如用户管理表单、订阅创建页面、产品-API关联选择器，收集用户输入的信息后，将请求发送到你的后端服务。
2. 后端层：作为前端和APIM API的中间层，核心职责包括：
   • 从服务主体凭据获取Azure AD访问令牌（避免将敏感凭据暴露在前端）
   • 将前端的请求参数转换成APIM管理API要求的格式
   • 调用APIM API并处理响应，将结果返回给前端
3. 错误处理：针对APIM API返回的各种错误（比如权限不足、资源不存在、参数格式错误），在后端做统一处理后，给前端返回友好的提示信息。

四、伪代码示例（创建订阅） #

这里给你一个简化的伪代码示例，展示如何通过后端调用APIM API创建订阅：

# 第一步：获取Azure AD访问令牌
def get_aad_token(tenant_id, client_id, client_secret):
    token_url = f"https://login.microsoftonline.com/{tenant_id}/oauth2/token"
    payload = {
        "grant_type": "client_credentials",
        "client_id": client_id,
        "client_secret": client_secret,
        "resource": "https://management.azure.com/"
    }
    response = requests.post(token_url, data=payload)
    return response.json()["access_token"]

# 第二步：调用APIM API创建订阅
def create_apim_subscription(token, subscription_id, rg_name, apim_name, subscription_name, user_id, product_id):
    api_url = f"https://management.azure.com/subscriptions/{subscription_id}/resourceGroups/{rg_name}/providers/Microsoft.ApiManagement/service/{apim_name}/subscriptions/{subscription_name}?api-version=2023-03-01-preview"
    headers = {
        "Authorization": f"Bearer {token}",
        "Content-Type": "application/json"
    }
    request_body = {
        "properties": {
            "displayName": "用户自定义订阅",
            "ownerId": f"/users/{user_id}",
            "scope": f"/products/{product_id}",
            "state": "active"
        }
    }
    response = requests.put(api_url, headers=headers, json=request_body)
    return response.json()

你可以在官方的APIM管理API文档里找到每个操作的详细参数、请求体格式和响应示例，确保你的调用符合规范。

内容的提问来源于stack exchange，提问作者Cristiano