axios通信時のhttpsAgentをnuxt.config.jsなどで共通設定したい

Question

@nuxtjs/axiosを使っているのですが、httpsAgentをnuxt.config.jsなどで共通設定する方法はないでしょうか？

apiエンドポイントなど、なるべく共通設定できるところは１箇所で定義しておきたいので現在の設定です。

---

• nuxt.config.js

module.exports = {
  // 省略
  modules: [
    '@nuxtjs/axios',
  ],
  axios: {
    browserBaseURL: envSet.apiBaseUrl.client,
    baseURL: envSet.apiBaseUrl.express,
  },
  // 省略
}

• pages/index.vue

export default {
  asyncData({ $axios }) {

    console.log($axios.defaults) // エンドポイント確保されてるか確認。

    return $axios.get('/test')
      .then((res) => {
        console.log(res.data)
        return res.data
      })
  },
}

---

このままだとself signed certificateというエラーがでるので、本番環境以外ではSSL証明書の検証を無視させます。

• pages/index.vue

import https from 'https'

export default {
  asyncData({ $axios }) {

    console.log($axios.defaults) // エンドポイント確保されてるか確認。

    const agent = new https.Agent({
      rejectUnauthorized: false
    });

    return $axios.get('/test', { httpsAgent: agent })
      .then((res) => {
        console.log(res.data)
        return res.data
      })
  },
}

これでエラーは全てなくなりましたが、ajax通信実行箇所ごとに{ httpsAgent: agent }を記述していくのは現実的ではないと思っています。

なので、以下のようにやってみましたが、有効になっていないようです。

• nuxt.config.js

import https from 'https'

module.exports = {
  // 省略
  modules: [
    '@nuxtjs/axios',
  ],
  axios: {
    browserBaseURL: envSet.apiBaseUrl.client,
    baseURL: envSet.apiBaseUrl.express,
    httpsAgent: new https.Agent({ rejectUnauthorized: false })
  },
  // 省略
}

何か方法はないでしょうか？

Answer 1

最初で設定するというよりは、$axios.onRequestで通信実行時をキャッチできるのでそのときにhttpsAgentを変更する。

• plugin/axios.js

import https from 'https'

export default function ({$axios}) {

  $axios.onRequest(config => {
    config.httpsAgent = new https.Agent({
      rejectUnauthorized: process.env.NODE_ENV === 'production'
    });
  })

}

• nuxt.config.js

const colors = require('vuetify/es5/util/colors').default
const environment = process.env.NODE_ENV || 'development';
const envSet = require(`./env.${environment}.js`)


module.exports = {
  mode: 'universal',
  env: envSet,
  plugins: [
    '~/plugins/axios'
  ],
  modules: [
    '@nuxtjs/axios',
  ],
  axios: {
    browserBaseURL: envSet.apiBaseUrl.client,
    baseURL: envSet.apiBaseUrl.express,
  },
}

• pages/index.vue

<script>
import Logo from '~/components/Logo.vue'
import VuetifyLogo from '~/components/VuetifyLogo.vue'

export default {
  components: {
    Logo,
    VuetifyLogo
  },
  asyncData({ $axios }) {
    return $axios.get('/test')
      .then((res) => {
        console.log(res.data)
        return res.data
      })
  },
  mounted: function () {
    this.$axios.get('/test')
      .then((res) => {
        console.log(res.data)
        return res.data
      })
  }
}
</script>

Answer 2

Nuxt.jsの場合、pluginsを使うのが良いと思います。
Axiosモジュールのインタセプタを設定します。

https://axios.nuxtjs.org/extend

// nuxt.config.js
config = {
  // ...

  plugins: ['@/plugins/axios'],

  // ...
}

// plugins/axios.js
export default function ({ $axios, store, isDev }) {
  $axios.onRequest((config) => {
    if (isDev) {
      // 例
      config.headers.Authorization = `Bearer ${store.state.loginUser.accessToken}`
    }
  })
}

Comments

[yuhigash]

環境毎にbaseURLを変更する場合は、「config.baseURL = process.env.baseURL」というふうにかけます。
envはnuxt.config.jsのenvプロパティに設定します。

[退会済みユーザー]

回答ありがとうございます。

以下のエラーがでてしまいます。

`Cannot read property 'onRequest' of undefined`

また、isDevはどこから参照されているのでしょうか？

[退会済みユーザー]

pluginは試してはいたのですが、肝心の部分の記載が分からず詰まっていました。

```
export default function ({ $axios }) {

}
```

上記の部分は結局以下と同じ形なので、$axios.get時に{ httpsAgent: agent }をセットする形になると思います。

```

export default {
asyncData({ $axios }) {

console.log($axios.defaults) // エンドポイント確保されてるか確認。

const agent = new https.Agent({
rejectUnauthorized: false
});

return $axios.get('/test', { httpsAgent: agent })
.then((res) => {
console.log(res.data)
return res.data
})
},
}
```

[yuhigash]

記憶している限りですが、NuxtのContextが引数として与えられたと思います。
https://ja.nuxtjs.org/api/context/

$axios.onRequest()はAxiosでリクエストを送る際に、インタセプタとして呼ばれます。
ですので、リクエストに関する設定をここに記述すると、共通化できます。
詳細は「https://axios.nuxtjs.org/extend」を御覧ください。

`Cannot read property 'onRequest' of undefined`
こちらのエラーですが、$axiosがundefinedのようです。
nuxt.config.jsの設定もしくは、plugins/axios.jsの設定が誤っていると考えられます。

[退会済みユーザー]

ドキュメントは勿論みていますが、それで理解できる人はいいのですが、理解できないのでここで質問しています。

`Cannot read property 'onRequest' of undefined` はnuxt.config.jsに以下を追加するのを忘れていました。

modules: [
'@nuxtjs/axios',
],