【SSR】Nuxt.jsで@nuxtjs/axiosを使って外部APIにリクエストを投げてレスポンスを取得・表示してみよう【Vue.js】

【最新機種】GoPro hero11 Black

【最新機種】GoPro HERO13 Black【完全防水】

created by Rinker

¥61,300 (2025/01/05 20:59:47時点楽天市場調べ-詳細)

最新機種でVlogの思い出を撮影しよう！

[ノースフェイス] THE NORTH FACE メンズアウターマウンテンライトジャケット

created by Rinker

THE NORTH FACE(ザノースフェイス)

¥33,000 (2025/01/05 13:22:08時点 Amazon調べ-詳細)

防水暴風で耐久性抜群なので旅行で大活躍です！

レッドブルエナジードリンク 250ml×24本

created by Rinker

Red Bull(レッドブル)

¥4,000 (2025/01/05 12:33:39時点 Amazon調べ-詳細)

翼を授けよう！

モンスターエナジー 355ml×24本 [エナジードリンク]

アサヒ飲料モンスターエナジー 355ml×24本 [エナジードリンク]

created by Rinker

モンスター

¥4,718 (2025/01/05 12:33:40時点 Amazon調べ-詳細)

脳を活性化させるにはこれ！

ドラゴンクエストメタリックモンスターズギャラリーメタルキング

created by Rinker

スクウェア・エニックス(SQUARE ENIX)

¥3,940 (2025/01/05 12:41:47時点 Amazon調べ-詳細)

みんな大好き経験値の塊をデスクに常備しておこう！

Bauhutte ( バウヒュッテ ) 昇降式 L字デスクブラック BHD-670H-BK

created by Rinker

Bauhutte(バウヒュッテ)

¥15,855 (2025/01/05 12:09:12時点 Amazon調べ-詳細)

メインデスクの横に置くのにぴったりなおしゃれな可動式ラック！

BANDAI SPIRITS ULTIMAGEAR 遊戯王千年パズル 1/1スケール

created by Rinker

BANDAI SPIRITS(バンダイスピリッツ)

¥10,429 (2025/01/05 12:09:13時点 Amazon調べ-詳細)

もう一人の僕を呼び覚ませ！！

目次 [閉じる]

1 Nuxt.jsならAPI呼び出しも簡単
2 手順
3 終わりに

Nuxt.jsならAPI呼び出しも簡単

前回の記事では、Nuxt.jsプロジェクトにTypeScriptを導入するところまで進めました。

参考

【Nuxt.js】プロジェクトに後から自前でTypeScriptを導入する方法【yarnでサクッと簡単】

今回は、Nuxt.js内部で外部APIへのリクエストを行って、そのレスポンスを画面に表示するところまでを作ってみようと思います。

手順

モジュールをインストール

まずは例の如くyarnコマンドでモジュールをインストールしましょう。

今回はNuxt.jsから公開されている@nuxtjs/axiosをインストールします。

yarn add v1.16.0
[1/4] Resolving packages...
[2/4] Fetching packages...
[3/4] Linking dependencies...
[4/4] Building fresh packages...
success Saved lockfile.
success Saved 10 new dependencies.
info Direct dependencies
└─ @nuxtjs/axios@5.5.4
info All dependencies
├─ @nuxtjs/axios@5.5.4
├─ @nuxtjs/proxy@1.3.3
├─ axios-retry@3.1.2
├─ axios@0.19.0
├─ eventemitter3@3.1.2
├─ follow-redirects@1.5.10
├─ http-proxy-middleware@0.19.1
├─ http-proxy@1.17.0
├─ is-retry-allowed@1.1.0
└─ requires-port@1.0.0
Done in 124.66s.

yarn add v1.16.0

[1/4] Resolving packages...

[2/4] Fetching packages...

[3/4] Linking dependencies...

[4/4] Building fresh packages...

success Saved lockfile.

success Saved 10 new dependencies.

info Direct dependencies

└─ @nuxtjs/axios@5.5.4

info All dependencies

├─ @nuxtjs/axios@5.5.4

├─ @nuxtjs/proxy@1.3.3

├─ axios-retry@3.1.2

├─ axios@0.19.0

├─ eventemitter3@3.1.2

├─ follow-redirects@1.5.10

├─ http-proxy-middleware@0.19.1

├─ http-proxy@1.17.0

├─ is-retry-allowed@1.1.0

└─ requires-port@1.0.0

Done in 124.66s.

axiosとは？

axios とは、様々なブラウザやNode.js環境で使う事の出来るプロミスベースのHttpクライアントです。

今時のフロントエンドでは、axiosを使ってHttpリクエストを行うのがデファクトとなっています。

Promise based HTTP client for the browser and node.jsaxios/axios: Promise based HTTP client for the browser and node.js

また、Nuxt.jsは今回インストールした@nuxtjs/axiosモジュールによって、よりNuxt.js内で使いやすくなっているので、基本的にはこちらを使う事になります。

nuxt.config.jsの編集

次に、インストールしたモジュールを利用する設定を追記します。

module.exports = {
  modules: [
      '@nuxtjs/style-resources',
      '@nuxtjs/axios' // 追加
  ],
...
(略)
...
}

module.exports = {

modules: [

'@nuxtjs/style-resources',

'@nuxtjs/axios' // 追加

...

(略)

...

}

asyncDataの修正

次に、実際にaxiosを使ってAPIから値を取得する部分を記述してみましょう。

import { Component, Vue, Prop } from 'vue-property-decorator'

@Component({
  components: {
  },
  async asyncData ({app,params}) { // 分割代入引数にappを追加
    const data = await app.$axios.$get(`http://localhost:3001/accounts/${params.id}`) // appの中の$axiosを使用
    return {data};
  }
})

export default class Index extends Vue {}

import { Component, Vue, Prop } from 'vue-property-decorator'

@Component({

components: {

async asyncData ({app,params}) { // 分割代入引数にappを追加

const data = await app.$axios.$get(`http://localhost:3001/accounts/${params.id}`) // appの中の$axiosを使用

return {data};

}

})

export default class Index extends Vue {}

axiosをimportすることなく、インジェクションしたapp経由で簡単に利用することが出来ます。

ちなみに、今回はMockoonを使って以下のレスポンスを返すStubを用意してそちらにアクセスしようと思います。

参考

【簡単オススメMockAPI】Mockoonを使って爆速でMacやWindowsマシンのローカル環境にStubサーバーを作ってみよう【Node.js】

{
    "id": "{{urlParam 'id'}}",
    "name" : "Stub",
    "age": 999
}

{

"id": "{{urlParam 'id'}}",

"name" : "Stub",

"age": 999

}

確認

では、実際にhttp://localhost:3000/accounts/12345 へアクセスしてみましょう。

正常に外部APIへリクエストを投げて、レスポンスを表示出来ましたね♪

終わりに

以上のように、Nuxt.jsであればaxiosを導入するのも一瞬でした。

基本的には、このように外部サーバーへのアクセスを行ってレスポンスを取り扱うことになると思うので、是非参考にしてみてください♪

【SSR】Nuxt.jsで@nuxtjs/axiosを使って外部APIにリクエストを投げてレスポンスを取得・表示してみよう【Vue.js】

【最新機種】GoPro hero11 Black

[ノースフェイス] THE NORTH FACE メンズ アウター マウンテンライトジャケット

レッドブル エナジードリンク 250ml×24本

モンスターエナジー 355ml×24本 [エナジードリンク]

ドラゴンクエスト メタリックモンスターズギャラリー メタルキング

Bauhutte ( バウヒュッテ ) 昇降式 L字デスク ブラック BHD-670H-BK

BANDAI SPIRITS ULTIMAGEAR 遊戯王 千年パズル 1/1スケール

Nuxt.jsならAPI呼び出しも簡単

手順

モジュールをインストール

axiosとは？

nuxt.config.jsの編集

asyncDataの修正

確認

終わりに

CATEGORIES & TAGS

[ノースフェイス] THE NORTH FACE メンズアウターマウンテンライトジャケット

レッドブルエナジードリンク 250ml×24本

ドラゴンクエストメタリックモンスターズギャラリーメタルキング

Bauhutte ( バウヒュッテ ) 昇降式 L字デスクブラック BHD-670H-BK

BANDAI SPIRITS ULTIMAGEAR 遊戯王千年パズル 1/1スケール