7.4. Eclipse MicroProfile OpenAPI リファレンス

mp.openapi.extensions.enabled

true

OpenAPI エンドポイントの登録を有効または無効にします。

false に設定すると、OpenAPI ドキュメントの生成を無効にします。config サブシステムを使用するか、/META-INF/microprofile-config.properties などの設定ファイルの各アプリケーションに対して、グローバルに値を設定できます。

このプロパティーをパラメーター化することで、実稼働や開発などの異なる環境で microprofile-openapi-smallrye を選択的に有効または無効にすることができます。

このプロパティーを使用すると、指定の仮想ホストに関連付けられたアプリケーションが MicroProfile OpenAPI モデルを生成するかを制御できます。

mp.openapi.extensions.path

/openapi

このプロパティーを使用して、仮想ホストに関連付けられた複数のアプリケーションの OpenAPI ドキュメントを生成することができます。

同じ仮想ホストに関連付けられた各アプリケーションに、個別の mp.openapi.extensions.path を設定します。

mp.openapi.extensions.servers.relative

true

自動生成されるサーバーレコードが絶対的なものであるか OpenAPI エンドポイントの場所と相対的であるかを示します。

root 以外のコンテキストパスが存在するところで OpenAPI ドキュメントの利用者が OpenAPI エンドポイントのホストとの関連した REST サービスへの有効な URL を作成できるようにするサーバーレコードが必要です。

値が true の場合は、サーバーレコードが OpenAPI エンドポイントの場所に対して相対的であることを示します。生成されたレコードには、デプロイメントのコンテキストパスが含まれます。

false に設定すると、JBoss EAP XP は、デプロイメントにアクセスできるすべてのプロトコル、ホスト、およびポートを含むサーバーレコードを生成します。