Guides - Latest
チュートリアル
すぐ使い始めるための短く、焦点を絞ったエクササイズ。
Auth0 OpenID Connectプロバイダーを使用したQuarkus Webアプリケーションの保護
Quarkus Securityは、quarkus-oidcエクステンションによって、包括的なOpenId Connect(OIDC)とOAuth2のサポートを提供し、認可コードフローとベアラートークン認証メカニズムの両方をサポートします。
Getting Started with Security using Basic authentication and Jakarta Persistence
Get started with Quarkus Security by securing your Quarkus application endpoints with the built-in Quarkus Basic authentication and the Jakarta Persistence identity provider and enabling role-based access control.
Migrate from OpenTracing to OpenTelemetry tracing
Migrate an application from OpenTracing to OpenTelemetry tracing in Quarkus 3.x.
OpenID Connect(OIDC)ベアラートークン認証によるサービスアプリケーションの保護
Quarkus OpenID Connect(OIDC)エクステンションを使用して、Bearerトークン認証でJakarta RESTアプリケーションを保護します。
Quarkus - 認可コードフローのOpenID Connectを使用してWebアプリケーションを保護
Quarkus OpenID Connect(OIDC)エクステンションを使用すると、OIDC 認可コードフローメカニズムを使用して、アプリケーションのHTTPエンドポイントを保護できます。
チュートリアルの作成
架空のエクステンションからのアノテーションを使用する Quarkus アプリケーションの作成、実行、およびテストをユーザーに説明する新しいチュートリアルを作成します。
マイクロメータを用いたメトリクスの収集
Micrometer メトリクスライブラリーを使用して、ランタイム、エクステンション、アプリケーションのメトリクスを収集し、Prometheus (OpenMetrics) エンドポイントとして公開するアプリケーションを作成します。
ハウツーガイド
主要なタスク、実際の操作、一般的な問題をカバーするためのステップバイステップガイド。
Quarkusドキュメントの寄稿方法
QuarkusのWebサイトポータルでコンテンツが正常にレンダリングされるように、推奨されるコンテンツタイプ、ステップ、ワークフロー、スタイルガイダンスを使用して、ドキュメントに貢献します。
YAML configuration
Optionally, use application.yaml
instead of application.properties
to configure your application.
コンセプト
Quarkus に関連するいくつかのより大きな概念とテクノロジーの解説。
OpenID Connect (OIDC) ベアラートークン認証
Quarkus OpenID Connect(OIDC)エクステンションを使用することで、ベアラートークン認証を使って、アプリケーション内のJakarta REST(旧称JAX-RS)エンドポイントへのHTTPアクセスを保護できます。
Quarkus Securityの概要
Quarkus Securityでは、開発者がQuarkusアプリケーションの商用品質のセキュリティーを構築するためのアーキテクチャ、複数の認証および認可メカニズム、その他のツールを提供しているフレームワークです。
Quarkusにおけるセキュリティ脆弱性の検出と報告
Quarkusのタグの多くは、米国のNational Vulnerability Database(NVD)にCPE(Common Platform Enumeration)の名称形式で登録されています。
Quarkusの認証メカニズム
Quarkus Securityフレームワークは、複数の認証メカニズムをサポートしており、これを使用してアプリケーションを保護することができます。
Web アプリケーションを保護するための OpenID Connect 認可コードフローメカニズム
ウェブアプリケーションを保護するには、Quarkus OIDCエクステンションが提供する業界標準のOpenID Connect(OIDC)認可コードフローメカニズムを使用できます。
よく知られたOpenID Connect プロバイダーの設定
このドキュメントでは、よく知られているソーシャル OIDC および OAuth2 プロバイダの設定方法について説明します。
クロスオリジンリソース共有
Cross-origin resource sharing (CORS) is an HTTP-header-based mechanism that allows a server to indicate any origins other than its own, from which a browser should permit loading resources.
コンテキストの重複、コンテキストローカル、非同期処理と伝播
従来型の、ブロッキング、同期フレームワークを使う場合、各リクエストの処理は専用のスレッドで実行されます。
リファレンス
ツール、コンポーネント、およびコマンドをカバーするテクニカルリソース。 Quarkus の百科事典。
Quarkus Cheat Sheet
Infinispanクライアントエクステンションリファレンスガイド
Infinispanは、インメモリ分散型データストアおよびキャッシュサーバーで、柔軟な導入オプションと、データの保存、管理、処理のための堅牢な機能を提供します。
OpenID Connect (OIDC) 設定プロパティ
Quarkusの開発者は、src/main/resources/application.propertiesファイルに以下のプロパティを設定することで、Quarkus OpenID Connect(OIDC)エクステンションを設定します。
Quarkusでデータソースを設定
統一された設定モデルを使用して、Java Database Connectivity (JDBC) および Reactive ドライバのデータソースを定義します。
Quarkusスタイル・コンテンツガイドライン
ガイドラインは、Quarkusドキュメントに必要な構造や構成に基づいた、明確で一貫性のあるコンテンツを提供するためのものです。
Using transactions in Quarkus
The quarkus-narayana-jta extension provides a Transaction Manager that coordinates and expose transactions to your applications as described in the link: Jakarta Transactions specification, formerly known as Java Transaction API (JTA).
ロギング設定
QuarkusでのロギングAPIの使用、ロギング出力の設定、他のロギングAPIからの出力を統一するためのロギングアダプタの使用について解説します。
その他のガイド
その他のQuarkusガイド
.propertiesファイルでセキュリティーを使用
このガイドでは、Quarkusアプリケーションが.propertiesファイルを使用してユーザーIDを保存する方法を説明します。
AMQP 1.0 を使用した SmallRye Reactive Messaging を使い始める
このガイドでは、QuarkusアプリケーションがSmallRye Reactive Messagingを使用してAMQPと対話する方法を説明します。
Apache Kafka を使用した SmallRye Reactive Messaging の概要
このガイドでは、Quarkus アプリケーションが SmallRye Reactive Messaging を利用して Apache Kafka とやりとりする仕組みを説明します。
Apache Kafka ストリームの使用
このガイドでは、QuarkusアプリケーションでApache Kafka Streams APIを利用して、Apache Kafkaをベースにしたストリーム処理アプリケーションを実装する方法を説明します。
Apache Kafka リファレンスガイド
このリファレンスガイドでは、Apache KafkaとSmallrye Reactive Messagingフレームワークについて詳しく説明しています。
Apache Pulsar リファレンス・ガイド
このリファレンス・ガイドは、Apache PulsarとSmallryeリアクティブ・メッセージング・フレームワークを詳しく紹介します。
Apache PulsarによるSmallRyeリアクティブ・メッセージング入門
このガイドでは、QuarkusアプリケーションがSmallRye Reactive Messagingを利用してApache Pulsarと対話する方法を説明します。
Azure Functions と Funqy HTTP バインディング
サーバーレスQuarkusアプリケーションのデプロイには、Microsoft Azure FunctionsとFunqy HTTPバインディングを使用してください。
Dev Services for Databases
開発モードでテストまたは実行する場合、Quarkus は設定不要のデータベースをすぐに提供できます。これは、Dev Servicesと呼ばれる機能です。
Dev Services for Pulsar
Quarkus Smallrye Reactive Messaging Pulsarエクステンション(quarkus-smallrye-reactive-messaging-pulsar)を使用すると、Pulsar用Dev Servicesが、開発モード時やテスト実行時に自動的にPulsarブローカーを起動します。
Dev Services for RabbitMQ
Dev Services for RabbitMQは、開発モードとテスト実行時に自動的にRabbitMQブローカーを起動します。
Elasticsearchクラスターの実行
このガイドでは、低レベルのRESTクライアントまたはElasticsearch Javaクライアントを使用して、Elasticsearchクラスタと対話する方法を説明します。
Google Cloud Functions (Serverless) with RESTEasy, Undertow, or Reactive Routes
このガイドでは、Vert.x Web、Servlet、またはRESTEasyマイクロサービスをGoogle Cloud Functionとしてデプロイする方法を説明します。
Google Cloud Functionsを使用した Funqy HTTP バインディング
FunqyのGoogle Cloud Platform FunctionsのHTTPバインディングについて解説します。
Hibernate ORMとJakarta Persistenceの使用
Hibernate ORMは、Jakarta Persistenceのデファクトの実装であり、Object Relational Mapperの全ての機能を提供します。
Hibernate Reactiveの使用
Hibernate Reactiveは、Hibernate ORMのリアクティブAPIで、ノンブロッキングデータベースドライバとデータベースとのリアクティブスタイルのインタラクションをサポートしています。
Hibernate Search ガイド
Hibernate Searchは、Elasticsearchクラスタ内のエンティティをインデックス化し、Hibernate ORMベースのすべてのアプリケーションで簡単に全文検索を提供することができます。
Hibernate Validatorによるバリデーション
このガイドでは、RESTサービスでHibernate Validator/Bean Validationを使用する方法について説明します。
JMSの使用
このガイドでは、Quarkusアプリケーションが、Apache Qpid JMSを使用してAMQP 1.0でJMSメッセージングを使用する方法、またはApache ActiveMQ Artemis JMSを使用する方法を説明します。
JSONウェブトークン (JWT) のビルド、署名、暗号化
RFC7519 によると、JSON Web トークン (JWT) は、JSON Web 署名 (JWS) 構造のペイロードとして、または JSON のプレーンテキストとして使用される JSON オブジェクトとしてエンコードされるクレームを表す、コンパクトで URL セーフな手段です。 Web 暗号化 (JWE) 構造により、クレームをデジタル署名したり、メッセージ認証コード (MAC) で完全性を保護したり、暗号化したりできます。
JWT RBAC の使用
このガイドでは、アプリケーションでSmallRye JWTを利用して、Jakarta RESTエンドポイントへのセキュアなアクセスを提供する方法について説明します。
Keycloak Admin Clientの使用
Quarkus Keycloak Admin Clientとそのreactiveの2つは、実行中のKeycloakサーバーを設定するために使用できるKeycloak Admin Clientをサポートしています。
Liquibase MongoDBの使用
Liquibase はデータベースのスキーマ変更管理のためのオープンソースツールで、そのMongoDB Extension を介して MongoDB データベースを管理することができます。
Mutinyによる非同期入門
Mutinyは、直感的でリアクティブなプログラミングライブラリです。
OAuth2 RBACの使用
このガイドでは、QuarkusアプリケーションでOAuth2トークンを利用して、JAX-RSエンドポイントへのセキュアなアクセスを提供する方法について説明します。
OpenAPIとSwagger UIの利用
このガイドでは、OpenAPI エクステンションを使用して OpenAPI ディスクリプタを生成し、Swagger UI フロントエンドを取得して REST エンドポイントをテストする方法を説明します。
OpenID Connect (OIDC) の開発サービスおよび UI
Keycloakや他のプロバイダーを開発モードやテストモードで自動的に起動します。
OpenID Connect (OIDC) マルチテナンシーの使用
このガイドでは、単一のアプリケーションから複数のテナントにサービスを提供できるように、OpenID Connectアプリケーションがマルチテナントをサポートする方法を示します。
OpenID Connect Client と Token Propagation のクイックスタート
このガイドでは、OpenID ConnectとOAuth2クライアント、フィルタを使用してアクセストークンを取得、更新、伝播する方法を説明します。
OpenID Connect(OIDC)とKeycloakを使った認可の中央管理
このガイドでは、QuarkusアプリケーションがKeycloak認可サービスを使用して保護されたリソースへのアクセスを認可する方法を説明します。
OpenTelemetryの使用
このガイドでは、QuarkusアプリケーションでOpenTelemetry を使用してインタラクティブなウェブアプリケーションで分散トレースを提供する方法について説明します。
PanacheでJakarta RESTリソースを生成する
Hibernate ORM REST Data with Panacheは、Jakarta RESTとHibernate ORMをベースにしたCRUDアプリケーションの作成を簡素化します。
Quarkus Extension Metadata
Quarkusのエクステンションは、アプリケーションや他のライブラリが依存する可能性のあるMaven JARアーティファクトとして配布されます。
Quarkus Mavenプラグイン
Quarkus Mavenプラグインは、Quarkusアプリケーションをビルドし、開発モードの起動やネイティブ実行可能ファイルのビルドのためのヘルパーを提供します。
Quarkus SecurityとJakarta Persistence
Quarkusには、JDBC IDプロバイダーと同様に、Jakarta Persistence(旧名称JPA)IDプロバイダーが用意されています。
Quarkus コマンドラインインターフェイス (CLI) を使用した Quarkus アプリの構築
Quarkus CLIを使用して、Quarkusプロジェクトのエクステンションを作成、ビルド、実行、管理します。
Quarkusの仮想スレッドによるgRPCサービスのサポート
このガイドでは、gRPCサービスを実装する際にJava仮想スレッドを利用する方法を説明します。
QuarkusアプリケーションからのEclipse Vert.x APIの使用
このガイドでは、QuarkusでVert.xを使用してリアクティブアプリケーションを構築する方法について説明します。
Quarkusベースランタイムイメージ
ネイティブ実行可能ファイルのコンテナ化を容易にするため、Quarkusには、これらの実行可能ファイルを実行するための要件を提供するベースイメージが用意されています。
Quartzによる定期的なタスクのスケジューリング
スケジュールされたタスクにクラスタリングのサポートが必要ですか?このガイドでは、そのための Quartz エクステンションの使い方を説明します。
RESTEasy Reactive を使用して REST サービスを作成する
Jakarta RESTとRESTEasy Reactiveを使用して、スケーラブルなリアクティブなRESTサービスを開発する方法を紹介します。
RESTEasy Reactive、Undertow、あるいはReactive Routesを使用したAWS Lambda
このガイドでは、Vert.x Web、Servlet、またはRESTEasyマイクロサービスをAWS Lambdaとしてデプロイする方法を説明します。
RESTEasy Reactive、Undertow、または Reactive Routes を使用した Azure Functions
Vert.x Web、Servlet、またはRESTEasyマイクロサービスをMicrosoft Azure Functionとしてデプロイ。
RESTEasy Reactiveへの移行
RESTEasy ClassicからRESTEasy Reactiveへの移行は、ほとんどの場合簡単ですが、いくつかの注意が必要なケースがあります。
RabbitMQによるSmallRyeリアクティブメッセージング入門
このガイドでは、QuarkusアプリケーションがSmallRye Reactive Messagingを利用してRabbitMQと対話する方法を説明します。
Reactive MessagingによるQuarkus仮想スレッドのサポート
このガイドでは、Quarkusでメッセージ処理アプリケーションを記述する際に、Java仮想スレッドを利用する方法について説明します。
Schema RegistryとAvroと共にApache Kafkaを使用
Apache Kafkaを使用し、Avroでシリアル化されたレコードを使用し、スキーマレジストリに接続します。
SmallRyeのフォールト・トレランス
このガイドでは、QuarkusアプリケーションがSmallRye Fault Toleranceエクステンションを使用してSmallRye Fault Tolerance仕様を使用する方法を説明します。
Spring BootプロパティAPIでアプリケーションのプロパティにアクセスする
MicroProfile Config アノテーションの代わりに Spring Boot の @ConfigurationProperties
を使用します
Spring Cache APIのためのQuarkusエクステンション
アプリケーションレベルのキャッシングにはCacheエクステンションを使用することが推奨されていますが、QuarkusはSpring Cacheエクステンションの形でSpring Cacheの互換性レイヤーを提供しています。
Spring Cloud Config Serverからのプロパティの読み込み
Quarkusは、Spring-cloud-config-clientエクステンションの形でSpring Cloud Config用の互換性レイヤーを提供しています。
Spring DI APIのためのQuarkusエクステンション
インジェクションにはCDIアノテーションを使用することが推奨されていますが、Quarkusはspring-diエクステンションの形でSpring依存性インジェクション用の互換性レイヤーを提供しています。
Spring Data API のエクステンション
データレイヤーにはHibernate ORM with Panacheを使用することが推奨されていますが、Quarkusはspring-data-jpaエクステンションの形でSpring Data JPAの互換性レイヤーを提供しています。
Spring Data RESTのエクステンション
Spring Data RESTは、当社のSpring Data互換性レイヤをベースにCRUDアプリケーションの作成を簡素化します。
Spring Scheduling APIのためのQuarkus Extension
SchedulerやQuartzのエクステンションを使ってタスクをスケジュールすることが推奨されていますが、QuarkusはSpring-scheduledエクステンションの形でSpring Scheduledとの互換性のあるレイヤーを提供しています。
Spring Security API の Quarkus エクステンション
Quarkus Securityレイヤーを使用してアプリケーションを保護することが推奨されていますが、Quarkusはspring-securityのエクステンションの形でSpring Securityとの互換性のあるレイヤーを提供しています。
Spring Web APIのためのQuarkus エクステンション
RESTエンドポイントの定義にはJakarta RESTアノテーションを使用することが推奨されていますが、QuarkusはSpring-webエクステンションという形でSpring Webとの互換性のあるレイヤーを提供しています。
アプリケーションの初期化と終了
アプリケーションの起動時にカスタムアクションを実行し、アプリケーションの停止時にすべてをクリーンアップする必要があることがよくあります。
エクステンション Codestart
code.quarkus.ioや、すべてのQuarkusツールでQuarkusアプリケーションを生成する際に、エクステンション用の初期コードをユーザーに提供する。
クロスサイトリクエストフォージェリー対策
クロスサイトリクエストフォージェリ(CSRF)は、エンドユーザーが現在認証されているウェブアプリケーション上で望まない動作を実行させる攻撃です。
コンテキストと依存性注入(CDI)の紹介
Quarkus DIソリューションは、Jakarta Contexts and Dependency Injection 4.0 仕様に基づいています。
シンプルになったHibernate ORM with Panache
Hibernate ORMは、Jakarta Persistenceのデファクトの実装であり、Object Relational Mapperの全ての機能を提供します。
シンプルになったHibernate ORM with PanacheとKotlin
KotlinプロジェクトでHibernate ORM with Panacheを使う場合に固有の事項について説明します。
シンプルになったMongoDB with PanacheとKotlin
このガイドでは、Kotlinプロジェクトでアクティブレコードやリポジトリを使ったMongoDBの使い方について説明します。
ネイティブイメージでのSSLの利用
このガイドでは、ネイティブイメージがそのままではSSLをサポートしていないため、ネイティブイメージをSSLに対応させる方法について説明します。
ネイティブ・アプリケーションを作成するためのヒント
このガイドは、アプリケーションをネイティブ実行可能ファイルにコンパイルする際に遭遇する問題を解決するためのヒントをまとめたものです。
ビルド分析
このガイドでは、ビルド分析とは何か、どのように設定するかを紹介します。
マルチパートでのRESTクライアントの使用
このガイドでは、RESTEasy Classic REST Client を使用してマルチパート REST リクエストを送信する方法について説明します。
レガシーREST クライアントの利用
This guide explains how to use the RESTEasy Classic REST Client in order to interact with REST APIs (JSON and other) with very little effort.
ログの一元管理(Graylog、Logstash、Fluentd)
このガイドでは、Graylog Extended Log Format (GELF) を使用して Logstash または Fluentd でログを集中管理する方法を説明します。
初期化タスク
このリファレンスガイドでは、初期化タスクの設定方法について説明します。