使用应用程序接口助手改进您的应用程序接口规范

您可以使用 API 助手分析您的 OpenAPI 3.0 规范,并生成有关验证修正和文档增强的人工智能建议。 改进应用程序接口规范可加快其被消费者采用的速度。

关于

中的 API 助手使用 IBM® API Connect 中的 API 助手使用 IBM watsonx Granite LLM 模型来帮助您更快地构建 API。 利用应用程序接口助手(API Assistant )可快速为您的应用程序接口定义生成人工智能修正,并为您的应用程序接口文档提供有用的说明和示例。

应用程序接口助手由以下两个部分组成:
规格验证错误
通过分析您的 OpenAPI 3.0 规范,并针对任何验证错误生成潜在的 AI 修复方案,从而改进您的 API;请参阅 《使用 API 助手进行错误修复 》。
规格改进
通过分析 API 定义并为描述和示例生成建议,来完善您的 API 文档;请参阅《 使用 API 助手编写 API 文档 》。
Draft comment: jendavidse@uk.ibm.com
We're calling this the API Assistant, and yet I don't see this term in the UI. I see "AI" as the title of the icon, and "AI recommendations" as the title of the panel. Can we put "API Assistant" as the title of the panel instead? Update: this query is still with design/prod mgt to consider. UI likely to completely change with the conversational API Assistant coming out in Dec 24.

限制

API 助手功能在调用人工智能生成器时受费率限制。 为获得最佳性能,请在中等规模的 API 上使用 API 助手

此外,还适用以下限制条件:
  • 您必须使用 "Premium subscription。 有关不同订阅和如何升级的信息,请参阅购买、订阅和升级信息
  • 您必须在 API Manager 中在线工作(不支持在 API Designer 中本地工作)。
  • 您的 API 定义必须符合 OpenAPI 3.0 规范(不支持 OpenAPI 2.0 )。