クラス GraphQlHttpHandler
java.lang.ObjectSE
org.springframework.graphql.server.webflux.AbstractGraphQlHttpHandler
org.springframework.graphql.server.webflux.GraphQlHttpHandler
WebFlux.fn GraphQL over HTTP リクエストのハンドラー。
- 導入:
- 1.0.0
- 作成者:
- Rossen Stoyanchev, Brian Clozel
フィールド概要
クラス org.springframework.graphql.server.webflux.AbstractGraphQlHttpHandler から継承されたフィールド
loggerコンストラクター概要
コンストラクターコンストラクター説明GraphQlHttpHandler(WebGraphQlHandler graphQlHandler) 新しいインスタンスを作成します。GraphQlHttpHandler(WebGraphQlHandler graphQlHandler, CodecConfigurer codecConfigurer) 新しいインスタンスを作成します。方法の概要
修飾子と型メソッド説明booleanGraphQL リクエスト実行フェーズが開始する前にエラーが発生した場合、この HTTP ハンドラーが HTTP 200 OK レスポンスを使用するかどうかを返します。たとえば、JSON 解析、GraphQL ドキュメント解析、または GraphQL ドキュメント検証が失敗した場合などです。protected reactor.core.publisher.Mono<ServerResponse> prepareResponse(ServerRequest request, WebGraphQlResponse response) 指定された GraphQL レスポンスのServerResponseを準備します。protected HttpStatusselectResponseStatus(WebGraphQlResponse response, MediaType responseMediaType) voidsetHttpOkOnValidationErrors(boolean httpOkOnValidationErrors) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。クラス org.springframework.graphql.server.webflux.AbstractGraphQlHttpHandler から継承されたメソッド
encode, encodeResponseIfNecessary, handleRequest
コンストラクターの詳細
GraphQlHttpHandler
新しいインスタンスを作成します。- パラメーター:
graphQlHandler- GraphQL over HTTP リクエストの共通ハンドラー
GraphQlHttpHandler
新しいインスタンスを作成します。- パラメーター:
graphQlHandler- GraphQL over HTTP リクエストの共通ハンドラーcodecConfigurer- JSON エンコードおよびデコード用のコーデックコンフィギュアラー
メソッドの詳細
isHttpOkOnValidationErrors
public boolean isHttpOkOnValidationErrors()GraphQL リクエスト実行フェーズが開始する前にエラーが発生した場合、この HTTP ハンドラーが HTTP 200 OK レスポンスを使用するかどうかを返します。たとえば、JSON 解析、GraphQL ドキュメント解析、または GraphQL ドキュメント検証が失敗した場合などです。このオプションは
MediaTypes.APPLICATION_GRAPHQL_RESPONSEレスポンスにのみ適用されます。従来のMediaType.APPLICATION_JSONレスポンスでは、このような場合に常に HTTP 200 OK が使用されます。このオプションを有効にすると、サーバーは「GraphQL over HTTP 仕様」に準拠しなくなります。デフォルトでは、これは
falseに設定されています。- 導入:
- 1.4.0
- 関連事項:
setHttpOkOnValidationErrors
@DeprecatedSE(since="1.4.0", forRemoval=true) public void setHttpOkOnValidationErrors(boolean httpOkOnValidationErrors) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。1.4 以降、将来のリリースではfalseに永続化される予定です。GraphQL リクエスト実行フェーズが開始する前にエラーが発生した場合に、この HTTP ハンドラーが HTTP 200 OK レスポンスを使用するかどうかを設定します。- パラメーター:
httpOkOnValidationErrors- "HTTP 200 OK" レスポンスを常に使用すべきかどうか- 導入:
- 1.4.0
- 関連事項:
prepareResponse
protected reactor.core.publisher.Mono<ServerResponse> prepareResponse(ServerRequest request, WebGraphQlResponse response) クラスからコピーされた説明:AbstractGraphQlHttpHandler指定された GraphQL レスポンスのServerResponseを準備します。- 次で指定:
- クラス
AbstractGraphQlHttpHandlerのprepareResponse - パラメーター:
request- 現在のリクエストresponse- GraphQL レスポンス- 戻り値:
- サーバーのレスポンス
selectResponseStatus
falseに永続化される予定です。