SuperAPI AI 工具集

api-doc-integration-risk-review

编程与开发

查看项目

更新于 10-15 19:55

技能介绍

用途:api-doc-integration-risk-review 是风险审阅助手,面向技术、管理者、软件与 API 文档场景,回答“这里有什么风险”类问题,帮助拆解目标、判断重点并形成可执行结果。

主要能力:结合上传接口资料、接口文档链接或粘贴的接口说明,整理关键上下文,输出摘要、诊断结论、行动建议和可复用交付物,并给出优先级与下一步动作。

使用方式:通过导出的 Python runner 调用 AI Skills API。基础调用:python3 scripts/run.py --params '{}';带参数调用:python3 scripts/run.py --params '{"apiGuideFile":"上传接口资料"}'。可选参数包括 apiGuideFile(上传接口文档、字段表、联调记录、错误码表或变更说明)、apiGuideLink(公开可访问的完整 URL)、apiGuideText(粘贴接口说明、鉴权方式、请求响应字段、错误码和调用限制)、integrationRiskFocus(可选值:字段完整性、错误处理、鉴权限流、联调风险,默认字段完整性)、dependencyConstraintNotes、integrationScenarioContext。完整参数结构见 references/form-schema.json。

运行前需配置 AISKILLS_BASE_URL(默认 https://ai-skills.ai)、AISKILLS_API_KEY(必填)、AISKILLS_TENANT_ID(默认 default)。

适用场景:需要围绕 API 文档集成风险生成摘要、诊断结论、行动建议和可复用交付物,或把相关材料转成清晰结论、优先级和下一步动作时使用。

限制:输入材料较少时,建议先补充目标、受众、限制条件或原始材料再运行;返回结果结构以技能真实返回为准。