Function useWebApiAdapter

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

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

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

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

    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