Documentation

RESTビルダーを使用したAPI

RESTビルダーとは、ローカルAPIをWeb上で利用しやすくするためのコード生成ツールです。 OpenAPI仕様 を使用し、RESTと GraphQL APIを生成します。

RESTビルダーは、 rest-config.yamlファイルおよびrest-openapi.yamlファイルで定義した設定を用いて、お客様のAPIの動作に必要なコードのほとんどを一度に生成します。 クラス名やコードの置き場所を設定すると、RESTビルダーが必要なファイルをすべて生成します。 その後、実装ロジックを追加します。

Liferay WorkspaceにあるimplモジュールからGradleタスクbuildRESTを使って、RESTビルダーを実行します。 設定完了後、すべてのビルディングブロックコード、インターフェース、そしてリソースクラスまで、実装の準備が整った状態で生成されます。