tyepscriptでAPIを叩いたときの型定義について

Question

#tyepscriptでAPIを叩いたときの型定義について
添付ファイルのようなデータが返ってくるとわかっている時は型定義は全てするべきなのでしょうか？

今は全てanyで定義しています。
ただ、tsでanyを使うとあまり意味もなく。
かと言って、添付ファイルのようなconfigやdata headersを全て定義するのは冗長なのではないかと感じます。
このような場合はどのようにすればいいのでしょうか？

コード

const atStaffPromise = apiConnect.postToApiGateway(
        state.atStaffParam.api,
        state.atStaffParam.dataObject
      )
      const atChildPromise = apiConnect.postToApiGateway(
        state.atChlldParam.api,
        state.atChlldParam.dataObject
      )
      const carPromise = apiConnect.postToApiGateway(
        state.carParam.api,
        state.carParam.dataObject
      )
      Promise.all([atStaffPromise, atChildPromise, carPromise])
        .then((responseArray: any | undefined) => {
          console.log(responseArray, 'responseArray')
        })
        .catch(err => {
          console.log(err)
        })

axiosのコードです。

async postToApiGateway(api: string, postDataObject: object) {
    let responseAwait
    const url =
      'https://pfuxp0z1e4.execute-api.ap-northeast-1.amazonaws.com/dev/' + api
    await axios
      .post(url, JSON.stringify(postDataObject), { headers: headers })
      .then(response => {
        responseAwait = response
      })
      .catch(error => {
        responseAwait = error
      })
    return responseAwait
  },

ご教授ください、よろしくお願いいたします。

Comments

[hoshi-takanori]

使うものだけ (たぶん data と status と statusText) を定義すれば充分です。

Answer 1

axiosではAxiosResponse<T>という型が公式で提供されていてresponseの型はそれに当たります。
https://github.com/axios/axios/blob/master/index.d.ts#L76

Tについてはresponse.dataの型ですね。こちらは開発者側で指定して上げる必要があります。指定しなければresponse.dataはanyです。postToApiGatewayのような汎用的な関数ですと、リクエスト先によってレスポンスデータは変わると思いますので、今回はTを指定するのは難しいかもしれません。

Comments

[art_porokyu]

ありがとうございます！