APIアシスタントを使用してAPI仕様を改善する

API Assistant を使用して、 OpenAPI 3.0 仕様を分析し、検証の修正やドキュメンテーションの強化に関する AI 推奨事項を生成できます。 APIの仕様を改善することで、消費者によるAPIの採用が加速する。

製品情報

の APIアシスタントは IBM® API Connect Enterprise as a Service は、 IBM watsonx Granite LLM モデルを使って、API をより速く構築できるようにします。 APIアシスタントを活用して、API定義のAI修正を素早く生成し、APIドキュメントに役立つ説明や例を提案します。

APIアシスタントは、以下の2つのコンポーネントで構成されています：

仕様の検証エラー: OpenAPI 3.0 の仕様を分析し、検証エラーのAI修正候補を生成することで、APIを改善します; エラー修正にAPIアシスタントを使用するを参照してください。
仕様の強化: API定義を分析し、説明や例に対する推奨事項を生成することで、APIドキュメントを改善します。APIアシスタントを使ってAPIをドキュメント化するを参照してください。

制限

APIアシスタント機能は、AIジェネレーターへの呼び出しにレート制限があります。最高のパフォーマンスを得るには、 API Assistantを中規模のAPIに使用してください。

また、以下の制限が適用される：

Premium subscription を使用しなければならない。各サブスクリプションとアップグレード方法については、購入、サブスクリプション、アップグレード情報をご覧ください。
API Manager でオンラインで作業する必要があります（API Designer でのローカル作業はサポートされていません）。
API定義はOpenAPI 3.0仕様に準拠していなければなりません(OpenAPI 2.0はサポートされていません)。