帮你快速理解、总结文档立即下载

管理 API

最近更新时间:2026-08-06 17:44:30
我的收藏

操作场景

API 管理是 API 服务创建完成后的统一运维入口。在同一个 API 服务下,您可以集中完成 API 的新建与配置、在线调试、发布上线、版本迭代、日志与监控查看、下线等全生命周期操作,同时管理该服务对外暴露所需的描述文件、调用凭证与数据脱敏策略,无需在多个模块间来回切换。

操作步骤

API 基础操作

页面支持新建 API、查看 API 的访问路径、请求方法、参数、后端服务类型等详细信息,也可编辑 API、发布 API。

API 列表页签,选择对应 API,单击调试,即可进入 API 调试页面。在 API 调试页面,您可以配置此 API Endpoint 的请求 Query、 Header、Body 或 Path 内容,配置好后单击发送请求。随后即可获取到测试的结果。我们会将后端服务返回的 Response 状态码和结果返回给用户,方便进行进一步的调试工作。

右上角单击上线,可发布此 API 到多个环境。

发布后的 API 状态为运行中

运行中的 API 界面单击右上角复制,可将当前版本覆盖到配置中的版本,复制后,API 服务可以再次发布。一个 API 服务可以发布到多个环境。

在 API 列表页可查看其日志监控,日志与监控的详细信息参见 运维中心 > 监控统计运维中心 > 运行日志

已经发布的 API 服务 下线,下线后原 API 访问地址将不可用。



查看描述文件

描述文件是针对当前 API 服务的说明,左侧展示 YAML/JSON 格式文件,右侧对应展示 Swagger 可视化内容。
支持将 API 文档导出为 Markdown 格式文件,方便调用方查看。

enter image description here



查看调用凭证

创建 API 服务时,若选择的鉴权策略为 NoAuth,则可忽略此选项,反之,若 API 服务需要鉴权,则需在此页面配置调用凭证。通过当前服务下的任意调用凭证,即可调用服务下任意 API。




上图为凭证列表页,创建好的凭证会展示在此处,选择新建凭证,即可创建新的凭证。自定义凭证的信息,保存即可。




订阅详情

上架后的 API 服务,可以被该企业主 UIN 下的所有子 UIN 订阅并调用,可以看到订阅该 API 的所有用户名单,同时,可以移除订阅




脱敏策略

支持针对 API 服务设置脱敏策略,上架后被订阅时可以选择绑定脱敏策略,从而实现对订阅者返回按脱敏策略处理过的响应报文。
操作入口为:API 服务详情->脱敏策略。

enter image description here


新建脱敏策略时,支持选择运行中的 API 服务,目前支持的脱敏规则如下,支持在一个脱敏策略中新增多个脱敏设置(每个脱敏设置对应一个 API 接口)。可以设置脱敏规则为:不脱敏直接返回、不返回、脱敏。

enter image description here


当选择脱敏时,支持选择预置脱敏规则和自定义脱敏规则。

自定义脱敏规则如下,支持设置掩码、哈希、关键字替换的脱敏算法。


示例

填写规则名称、脱敏算法、算法实现和描述,支持脱敏效果测试。为避免全局更换产生误伤及提高脱敏效率,在设置脱敏规则时,要对照 API 返回的 JSON 格式,在配置界面中自上而下逐层还原字段,通过定点路径精准改写敏感数据。操作如下示例。
原始数据
{
"code": "0",
"message": "success",
"data": {
"transformerId": "T-500KV-BJ-001",
"name": "北京500kV变电站#1主变",
"deviceParams": {
"model": "ODFPS-1000MVA/500kV",
"structureType": "三相自耦变压器",
"ratedCapacity": "1000MVA",
"ratedVoltageHV": "550/√3 kV",
"ratedVoltageLV": "242/√3 kV",
"ratedVoltageTV": "66/√3 kV",
"ratedCurrentHV": "1049.7A",
"ratedCurrentLV": "2388.5A",
"impedanceVoltage": "18%",
"noLoadLoss": "285kW",
"loadLoss": "2200kW",
"coolingType": "强迫油循环风冷(ODAF)",
"insulationClass": "A级",
"connectionGroup": "YNa0d11",
"tapChanger": "MR VV型有载调压",
"tapRange": "±8×1.25%"
},
"manufacturer": {
"name": "西门子能源",
"country": "德国",
"address": "德国纽伦堡",
"contact": "13344556789",
"warrantyPeriod": "5年",
"serviceHotline": "400-888-XXXX"
},
"environmentalAdaptation": {
"altitude": "≤1000m",
"ambientTempRange": "-25℃ ~ +40℃",
"maxHumidity": "90%(20℃时)",
"seismicIntensity": "8度(0.2g)",
"pollutionLevel": "III级(中等污秽)",
"coolingWaterInletTemp": "≤33℃",
"noiseLimit": "昼间65dB/夜间55dB",
"emcCompliance": "GB/T 17626.2-2018",
"ipRating": "IP21(户外)"
}
}
}
脱敏规则设置,需要对手机号进行脱敏。

订阅 API 时选择脱敏策略。

访问 API 时使用凭证。

脱敏效果