Maven を使用した APIkit プロジェクトの作成

Maven コマンドを使用して、既存の Maven プロジェクト (RAML と APIkit を使用して最新化する従来のプロジェクトなど) に APIkit のコンポーネントを追加できます。ローカルシステムに Apache Maven がインストールされている必要があります。

次のトピックを理解しておくことをお勧めします。

Maven 設定ファイル

.m2 ディレクトリ内に Mule リポジトリを含む Maven settings.xml ファイルが必要です。settings.xml ファイルがない場合は、Mule リポジトリを参照するこのファイルを作成します。settings.xml ファイルに次のコンテンツを追加します。

<settings>
    <pluginGroups>
        <pluginGroup>org.mule.tools</pluginGroup>
    </pluginGroups>
    <profiles>
        <profile>
            <activation>
                <activeByDefault>true</activeByDefault>
            </activation>
            <id>mule-repositories</id>
            <repositories>
                <repository>
                    <id>mulesoft-releases</id>
                    <name>MuleSoft Releases Repository</name>
                    <url>http://repository.mulesoft.org/releases/</url>
                </repository>
                <repository>
                    <id>mulesoft-snapshots</id>
                    <name>MuleSoft Snapshots Repository</name>
                    <url>http://repository.mulesoft.org/snapshots/</url>
                </repository>
            </repositories>
            <pluginRepositories>
                <pluginRepository>
                    <id>mulesoft-releases</id>
                    <name>MuleSoft Releases</name>
                    <url>http://repository.mulesoft.org/releases/</url>
                </pluginRepository>
                <pluginRepository>
                    <id>mulesoft-snapshots</id>
                    <name>MuleSoft Snapshots</name>
                    <url>http://repository.mulesoft.org/snapshots/</url>
                </pluginRepository>
            </pluginRepositories>
        </profile>
    </profiles>

</settings>

Maven アーキタイプコマンド

mvn archetype コマンドを使用して、プロジェクトの APIkit Anatomy Referenceを作成します。Maven は、 アーキタイプ と呼ばれるテンプレートにプロジェクトを作成する手順および関連付けられた設定を保存します。APIkit は、APIkit プロジェクトの作成ニーズに合わせて調整された特殊な Maven アーキタイプを提供します。Mule の公開リポジトリでホストされるため、ダウンロードする必要はありません。Maven コメントでその仮想アドレスを参照するだけです。

mvn archetype コマンドは、新しいプロジェクト、ディレクトリ構造、および空の api.raml ファイルを作成します。このコマンドは必要な連動関係を設定します。

mvn archetype パラメータ

mvn archetype パラメータは、アーキタイプを検索する場所を定義します。

パラメータ

archetypeGroupId

org.mule.tools

archetypeArtifactId

mule-apikit-archetype

archetypeVersion

1.2.5

archetypeRepository

http://repository.mulesoft.org/releases

アーキタイプバージョンは、生成されたアーティファクトに使用される APIKit プロジェクトのアーキタイプおよび APIKit バージョンです。

プロジェクトに固有の値を使用して、mvn archetype コマンドに次のパラメータを含めることができます。

パラメータ 説明

groupId

プロジェクトの標準 Maven グループ ID。

artifactId

Maven によってプロジェクトに与えられるファイル名。

package

メッセージプロセッサが稼働する Java パッケージ。

version

新しいプロジェクトのバージョン。

これらのパラメータを含めない場合、実行時に値の入力が求められます。

新規プロジェクトの生成

Studio で新規プロジェクトを生成する手順は、次のとおりです。

  1. ターミナルで、プロジェクトを作成するディレクトリに移動し、Anypoint Studio ワークスペースフォルダ内 (C:\Users\Aaron\workspace など) から次の Maven 生成コマンドを実行します。

    mvn archetype:generate -DarchetypeGroupId=org.mule.tools -DarchetypeArtifactId=mule-apikit-archetype -DarchetypeVersion=1.2.4 -DarchetypeRepository=http://repository.mulesoft.org/releases -DgroupId=org.mule.tools -DartifactId=APIKit-project -Dpackage=package-name -Dversion=1.0 -B

    Maven はプロジェクトファイルを Studio ワークスペースに保存します。

  2. 上記のパラメータが正しいことを確認するように求められます。Y と入力し、Enter キーを押して確認します。

    Maven は指定されたディレクトリに使用可能な最新の Mule Runtime を含む新しいプロジェクトを生成します。 以前のランタイムを使用するには、pom.xml ファイルを開き、<mule.version> XML タグのコンテンツを変更します。

RAML ファイルの準備

src/main/api 内の APIkit Anatomy Reference ファイルは最初は空です。ファイルに入力するには、次のいずれかのタスクを実行します。

  • api.raml ファイルを編集して API を定義する。

  • 例として提供された サンプル RAML ファイル を使用する。

  • 既存の RAML ファイルがある場合、API を定義する。

    • デフォルトの api.raml ファイルの内容を独自の記述で置き換える。
      または

    • mule-config.xml ファイルを編集して RAML 記述を含むファイルを参照する。

      apikit:config タグ内の属性 raml は、API 定義を取得するファイルを指定します。デフォルト値 api.raml を次のように RAML ファイルへのパスに置き換えます。

      <apikit:config name="apiConfig" raml="CUSTOM FILE NAME" consoleEnabled="true" consolePath="console" />

バックエンドフローの生成

作成した RAML の各リソースとアクションのペアリングで、APIkit Anatomy Referenceを生成する必要があります。

  1. コマンドラインから、プロジェクトを含む新しく作成したフォルダに移動します。

  2. 次の Maven コマンドを実行します。

    mvn org.mule.tools:mule-apikit-maven-plugin:create

    api.raml 内の情報から、プラグインがバックエンドフローを生成します。

Anypoint Studio へのプロジェクトのインポート

プロジェクトの基本構造を作成したら、そのプロジェクトを Anypoint Studio にインポートしてから、バックエンドフローを拡張して RAML リソースをアクションにマップします。

  1. Studio の [File (ファイル)] メニューで、[Import (インポート)] を選択します。

  2. [Import (インポート)] ウィザードで、Mule フォルダを展開して Maven-based Mule project from pom.xml を選択します。

    import maven
  3. ウィザードの残りの手順を完了し、ローカルドライブにあるプロジェクトの pom.xml の​名前​と​場所​を特定し、[Finish (完了)] をクリックしてプロジェクトをインポートします。

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub