第54章 OpenAPI サポートによる JAX-RS エンドポイントの拡張


概要

CXF OpenApiFeature (org.apache.cxf.jaxrs.openapi.OpenApiFeature) を使用すると、パブリッシュ済みの JAX-RS サービスエンドポイントを単純な設定で拡張することによって OpenAPI ドキュメントを生成できます。

OpenApiFeature は、Spring Boot および Karaf 実装の両方でサポートされます。

54.1. OpenApiFeature オプション

OpenApiFeature では、以下のオプションを使用できます。

表54.1 OpenApiFeature 操作
名前説明デフォルト

basePath

コンテキストルートパス+(usePathBasedConfig オプションも参照)

null

contact

連絡先情報

"users@cxf.apache.org"

description

説明+

アプリケーション"

filterClass

セキュリティーフィルター+

null

host

ホストおよびポート情報+

null

ignoreRoutes

すべてのリソースをスキャンする際に、特定のパスを除外します (scanAllResources オプションを参照)++

null

license

ライセンス+

"Apache 2.0 ライセンス"

licenceUrl

ライセンス URL+

http://www.apache.org/licenses/LICENSE-2.0.html

prettyPrint

openapi.json を生成する際に、JSON ドキュメントをプリティープリントで出力するように指定します。

false

resourcePackage

リソースのスキャンが必要なパッケージ名のコンマ区切りの一覧++

エンドポイントに設定されたサービスクラスの一覧

runAsFilter

機能をフィルターとして実行します。

false

scan

OpenAPI ドキュメントを生成します+

true

scanAllResources

アノテーション付きの JAX-RS リソースを含むすべてのリソースをスキャンします (ignoreRoutes オプションも参照)++

false

schemes

プロトコルスキーム+

null

openapiUiConfig

OpenAPI UI の設定

null

termsOfServiceUrl

サービス URL+

null

title

タイトル+

"サンプル REST アプリケーション"

usePathBasedConfig

OpenAPI が basePath オプションの値をキャッシュできないようにします。

false

version

バージョン+

"1.0.0"

+ オプションは OpenAPI の BeanConfig で定義されます。

++ オプションは OpenAPI の ReaderConfig で定義されます。

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

© 2024 Red Hat, Inc.