API 仕様の連動関係内での検索

API 仕様をプロジェクトの連動関係として Exchange または Maven からインポートすると、これらの連動関係は ​src/resources/api/​ からプロジェクトのクラスパスの ZIP ファイルに再配置されます。この変更により、Studio の [File Search (ファイル検索)] オプションを使用して API 連動関係を検索できなくなります。API 連動関係内で特定のテキストを検索できるようにするために、Studio では API 検索機能が導入されています。

[API Search (API 検索)] メニューには Anypoint Studio 画面の上部のタスクバーから、​[Search (検索)]​ > ​[Search…​ (検索…​)]​ を選択するか、キーボードのコントロールキーと H キーを同時に押してアクセスできます。

api search

API 仕様の連動関係内で検索する手順:

  1. 次の規則に従って検索するテキストを入力します。

    • 検索条件で任意の文字列を検索するには ​*​ を使用します。
      たとえば、​/*customer​ は ​/customers​ と ​/{customerId}​ の両方のエンドポイントに一致する可能性があります。

    • 特定のパターンの後の任意の文字を検索するには ​?​ を追加します。
      たとえば、​/?customer​ は ​/{customerId}​ には一致しますが ​/customers​ には一致しません。これは、​?​ リテラルの間で定義した検索条件の間に文字が存在している必要があるためです。

    • 検索パターンに使用される任意の予約済みリテラルをエスケープするには ​\​ を使用します。
      たとえば、​*​、​?​、または ​\​ が含まれる文字列を検索する場合、これらをエスケープして次のようにする必要があります: \*​、​\?​、​\\​。

  2. 検索するファイルに特定の名前のパターンを指定する場合は、次の規則に従って ​[File name patterns (ファイル名パターン)]​ 項目にパターンを入力します。

    • 検索条件で任意の文字列を検索するには ​*​ を使用します。
      たとえば、​*.raml​ は ​.raml​ 拡張子で終わるすべてのファイル名で検索します。

    • 特定のパターンの後で任意の文字を許可するには ​?​ を使用します。
      たとえば、​customer?1.raml​ は ​customer01.raml​、​customer11.raml​、または ​customer21.raml​ などのファイル内で検索します。

    • 特定のファイル名またはパターンを除外するには ​!​ を使用します。
      たとえば、​!examples.raml​ は ​examples.raml​ を除くすべてのファイル内で検索します。

  3. ファイルの種類別に絞り込むには ​[Choose…​ (選択…​)]​ ボタンをクリックします。

  4. プロジェクトで次のいずれかの種別の API 仕様を選択します。

    • [API dependencies (API 連動関係)]​ を選択すると、Exchange または Maven からインポートされた API 仕様内で検索します。

    • [Local API Files (ローカル API ファイル)]​ を選択すると、ローカルファイルまたは Anypoint Design Center から追加された API 仕様内で検索します。

  5. [Search (検索)]​ をクリックします。

Anypoint Studio 画面の上部にあるタスクバーで ​[Navigate (移動)]​ > ​[Open API Resource (API リソースを開く)]​ を選択するか、​cmd+Shift+P​ (MacOS) または ​control+shift+P​ (Windows/Linux) キーボードショートカットを仕様して完了していないプロジェクト内のすべての API 仕様を検索することもできます。

open api resource
  1. 探している API リソースの名前を入力します。

    open api resource result

    Studio に入力した API リソースに一致する可能性があるすべての項目が表示されます。

  2. 探していたリソースを選択して ​[OK]​ をクリックします。