Function useWebApiAdapter

  • useWebApiAdapter(): {
        get: (<T>(param: {
            option?: WebApiOption;
            webApiName: string;
        }) => Promise<WebApiResponse<T>>);
        post: (<T>(param: {
            data?: any;
            option?: WebApiOption;
            webApiName: string;
        }) => Promise<WebApiResponse<T>>);
    }

  • WebAPIの実行ロジックを生成します。

    例外が発生した場合は、自動でモーダルでエラーを表示します。 呼び出し元で例外処理を行いたい場合は、該当の例外クラスをWebAPI実行オプションで明示的に指定してください。

    Returns {
        get: (<T>(param: {
            option?: WebApiOption;
            webApiName: string;
        }) => Promise<WebApiResponse<T>>);
        post: (<T>(param: {
            data?: any;
            option?: WebApiOption;
            webApiName: string;
        }) => Promise<WebApiResponse<T>>);
    }

    • get: (<T>(param: {
          option?: WebApiOption;
          webApiName: string;
      }) => Promise<WebApiResponse<T>>)
        • <T>(param): Promise<WebApiResponse<T>>

        • Getリクエスト

          Type Parameters

          Parameters

          • param: {
                option?: WebApiOption;
                webApiName: string;
            }

            Getリクエスト実行時のパラメータ

            • Optionaloption?: WebApiOption

              WebAPI実行オプション

            • webApiName: string

              WebAPI名

          Returns Promise<WebApiResponse<T>>

          WebAPIレスポンス

    • post: (<T>(param: {
          data?: any;
          option?: WebApiOption;
          webApiName: string;
      }) => Promise<WebApiResponse<T>>)
        • <T>(param): Promise<WebApiResponse<T>>

        • Postリクエスト

          Type Parameters

          Parameters

          • param: {
                data?: any;
                option?: WebApiOption;
                webApiName: string;
            }

            Postリクエスト実行時のパラメータ

            • Optionaldata?: any

              Postデータ

            • Optionaloption?: WebApiOption

              WebAPI実行オプション

            • webApiName: string

              WebAPI名

          Returns Promise<WebApiResponse<T>>

          WebAPIレスポンス

    Example

    const { get } = Mdc.useWebApiAdapter();
    get({
     // 実際のWebAPIのURLパスは「tenantContextPath + "/api/" + webApiName」になります。
     webApiName: "mdc/test"
    }).then(({ data, isSuccess, error }) => {
     // WebAPIの実行結果
     // Commandの戻り値がSUCCESS以外の場合でも、200ステータスで正常にレスポンスが返った場合（例外が発生しなかった場合）はtrueになります
     console.log(isSuccess);
     // WebAPIのレスポンス
     console.log(data);

     if (isSuccess) {
       // 処理成功時のロジック
     }
    });

Settings

Member Visibility