クラス GraphQlHttpHandler

java.lang.ObjectSE
org.springframework.graphql.server.webmvc.AbstractGraphQlHttpHandler
org.springframework.graphql.server.webmvc.GraphQlHttpHandler
public class GraphQlHttpHandler extends AbstractGraphQlHttpHandler
RouterFunctions 経由で WebMvc 関数エンドポイントとして公開する GraphQL ハンドラー。
導入:
1.0.0
作成者:
Rossen Stoyanchev, Brian Clozel

  • コンストラクターの詳細

    • GraphQlHttpHandler

      public GraphQlHttpHandler(WebGraphQlHandler graphQlHandler)
      新しいインスタンスを作成します。
      パラメーター:
      graphQlHandler - GraphQL over HTTP リクエストの共通ハンドラー

    • GraphQlHttpHandler

      public GraphQlHttpHandler(WebGraphQlHandler graphQlHandler, @Nullable HttpMessageConverter<?> converter)
      GraphQL ペイロード用のカスタムメッセージコンバーターを使用して新しいインスタンスを作成します。

      コンバーターが提供されていない場合、ハンドラーは the one configured for web use を使用します。

      パラメーター:
      graphQlHandler - GraphQL over HTTP リクエストの共通ハンドラー
      converter - GraphQL ペイロードの読み取りと書き込みに使用するコンバーター

  • メソッドの詳細

    • 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 ServerResponse prepareResponse(ServerRequest request, reactor.core.publisher.Mono<WebGraphQlResponse> responseMono)
      クラスからコピーされた説明: AbstractGraphQlHttpHandler
      指定された GraphQL レスポンスの ServerResponse を準備します。
      次で指定:
      クラス AbstractGraphQlHttpHandler の prepareResponse 
      パラメーター:
      request - 現在のリクエスト
      responseMono - GraphQL レスポンス
      戻り値:
      サーバーのレスポンス

    • selectResponseStatus

      protected HttpStatus selectResponseStatus(WebGraphQlResponse response, MediaType responseMediaType)