AI を使用した API 仕様の作成
生成 API 仕様機能は、自然言語から API 仕様を生成およびモックすることで、API 設計ジャーニーに AI 機能を活用します。この機能により、厳密で構文の多い仕様の作成が簡略化され、API 設計にかかる時間が短縮されます。サポートされている RAML 1.0 または OAS 3.0 形式の API プロジェクトを作成した後、またはプロジェクト内の Agentforce を開くアイコンから、この機能にアクセスできます。このシステムではマルチターンの会話がサポートされ、検証済みの API 仕様が提供されます。
始める前に
API 仕様の作成を開始する前に、次の準備が整っていることを確認します。
-
必要な Anypoint Code Builder 権限があることを確認します。
-
Anypoint Code Builder Agentforce 機能を使用するには、次の権限があることを確認します。
-
Anypoint Code Builder Developer (Anypoint Code Builder 開発者)
-
Mule Developer Generative AI User (Mule 開発者生成 AI ユーザー)
-
-
[Access Management (アクセス管理)] で Einstein が有効化されていることを確認します。詳細は、「Enabling Einstein for Anypoint Platform (Anypoint Platform での Einstein の有効化)」を参照してください。
-
Anypoint Platform のログイン情報で Anypoint Code Builder にログインします。
-
Anypoint Code Builder でサポートされている RAML 1.0 または OAS 3.0 形式の API 仕様プロジェクトを作成し、ビジネスグループを選択します。ビジネスグループでは、Einstein 生成 AI が有効化されている必要があります。ビジネスグループを選択した後に Einstein 生成 AI がない場合は、Anypoint Platform 管理者に機能を有効化するよう依頼してください。
AI を使用して API 仕様を設計する
AI を使用して API 仕様を設計するには、まずスタータープロンプトでエージェントに必要なコンテキストのガイダンスを確認します。
-
チャットで API 仕様を説明します。エージェントは、要求を理解できない場合に明確な説明を求めます。
より正確な仕様を生成するには、次の必須の詳細を含め、省略可能な詳細も含めることを検討します。
基本詳細
必要に応じて、API 参照名、バージョン、説明を入力します。
セキュリティの詳細
Oauth 1.0、Oauth 2.0、基本認証、ダイジェスト認証、またはパススルーの種別の必要なセキュリティスキームを含めます。
-
基本認証、ダイジェスト認証、またはパススルーの場合、応答、クエリパラメーター、およびヘッダーを指定します。
-
Oauth 1.0 または 2.0 の場合、応答、クエリパラメーター、ヘッダー、設定を指定します。
-
Oauth 1.0 の設定は、
authorizationUri、requestTokenUri、tokenCredentialsUri、または署名の種別を使用できます。 -
Oauth 2.0 の設定は、
authorizationUri、requestTokenUri、または authorizationGrants の種別を使用できます。
-
次の追加の詳細が適用されます。
ヘッダーの要件
ヘッダーには、名前、必須かどうか、および次のいずれかのデータ型を含める必要があります。
-
Array (配列)
-
Boolean (ブール)
-
Date only (日付のみ)
-
DateTime
-
DateTime only (日時のみ)
-
File (ファイル)
-
nil
-
Number (数値)
-
Object (オブジェクト)
-
String (文字列)
-
Time only (時間のみ)
必要に応じて、ヘッダーの説明、形式、最小長と最大長、デフォルト値、例を入力します。
クエリパラメーターの要件
クエリパラメーターには、名前、必須かどうか、および次のいずれかのデータ型を含める必要があります。
-
Array (配列)
-
Boolean (ブール)
-
Date only (日付のみ)
-
DateTime (日時)
-
DateTime only (日時のみ)
-
File (ファイル)
-
nil
-
Number (数値)
-
Object (オブジェクト)
-
String (文字列)
-
Time only (時間のみ)
必要に応じて、クエリパラメーターの説明、形式、最小長と最大長、デフォルト値、例を入力します。
応答の要件
応答には状況コードと説明を含める必要があります。
リソースとメソッド
Oauth 1.0、Oauth 2.0、基本認証、ダイジェスト認証、またはパススルーの種別の必要なセキュリティスキームを含めます。
次の追加の詳細が適用されます。
リソースの要件
各リソースには次のメソッドを 1 つ以上含めることができます。
-
GET
-
POST
-
PUT
-
PATCH
-
DELETE
-
HEAD
-
OPTIONS
GET メソッドと HEAD メソッドの場合、概要、応答、要求、クエリまたはヘッダーパラメーターを含めることができます。
POST、PUT、PATCH、OPTIONS メソッドの場合、概要、応答、要求、本文、クエリまたはヘッダーパラメーターを含めることができます。
応答の要件
応答には状況コードと説明を含める必要があります。レスポンスボディは省略可能であり、説明、種別、メディアタイプ、例を含めることができます。
要求の要件
要求には説明と本文を含める必要があります。
ヘッダーの要件
ヘッダーには、名前、必須かどうか、および次のいずれかのデータ型を含める必要があります。
-
Array (配列)
-
Boolean (ブール)
-
Date only (日付のみ)
-
DateTime (日時)
-
DateTime only (日時のみ)
-
File (ファイル)
-
nil
-
Number (数値)
-
Object (オブジェクト)
-
String (文字列)
-
Time only (時間のみ)
必要に応じて、ヘッダーの説明、形式、最小長と最大長、デフォルト値、例を入力します。
クエリパラメーターの要件
クエリパラメーターには、名前、必須かどうか、および次のいずれかのデータ型を含める必要があります。
-
Array (配列)
-
Boolean (ブール)
-
Date only (日付のみ)
-
DateTime (日時)
-
DateTime only (日時のみ)
-
File (ファイル)
-
nil
-
Number (数値)
-
Object (オブジェクト)
-
String (文字列)
-
Time only (時間のみ)
必要に応じて、クエリパラメーターの説明、形式、最小長と最大長、デフォルト値、例を入力します。
-
-
メッセージを送信します。検証済みの API 仕様をエージェントが作成します。
| ガバナンスは検証に含まれません。 |
-
仕様を確認し、変更を加えたい場合は会話を続けます。
-
生成された API 仕様をプロジェクトに追加するには、[Replace (置換)] をクリックします。すべてのファイルコンテンツは挿入されたコードで置き換えられます。
[Copy (コピー)] をクリックして、生成された API 仕様をクリップボードにコピーすることもできます。
新しいチャットを開始する
サポートされている RAML 1.0 または OAS 3.0 形式でプロジェクトを開いている場合にのみ、API 仕様を作成できます。新しい API 仕様を作成するには、[New Chat (新規チャット)] ドロップダウンから [Create API Spec (API 仕様を作成)] をクリックします。
サポートされていない形式のプロジェクトでは、このオプションは表示されません。