質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

88.82%

Nuxtでapiをまとめるベストプラクティス

受付中

回答 2

投稿 編集

  • 評価
  • クリップ 0
  • VIEW 1,704

inami_173

score 22

APIのまとめ方

Nuxt.jsでFlaskで作成した外部APIに接続するアプリケーションを作成しています。
そこで、APIをどこか一つにまとめておきたいのですが、その場合のベストプラクティスはどのようになるでしょうか。
英語も含めいろいろと調べてみましたが、これといったものが見つかりませんでした。

また、Vueの場合は以下のように2つのファイルを使用してまとめていました。

// component/ApiClient.vue
<script>
import axios from 'axios'

const baseUrl = process.env.API_BASE_URI
axios.defaults.withCredentials = true

export default {
  data () {
    return {}
  },
  create: function (path, params, callback, errorHandler) {
    let targetPath = baseUrl + path    
    axios.post(targetPath, params).then((response) => {     
      callback(response)
    }).catch(function (error) {      
      errorHandler(error)
    })
  },
  ...
// component/MyService.vue
<script>
import ApiClient from './ApiClient'

export default {
  name: 'MyService',
  uploadedSounds: function (params, callback, errorHandler) {
    let targetPath = `/uploaded_sounds`
    ApiClient.create(
      targetPath,
      params,
      (response) => {callback(response)},
      (error) => {errorHandler(error)}
    )
  },
...

CORSについて

また、pagesフォルダ内のvueファイルでaxiosを用いたapiの呼び出しを行うと問題ないのですが、Nuxt.jsの場合、上記vueファイルの様に他のファイルにapiの機能を書き出し、それを呼び出した場合に限りCORS関連のエラーが発生します。
componentフォルダ以外にも、自分でapiというフォルダを作成した場合も、そのフォルダ内のapi呼び出しの処理はCORSエラーが発生しました。

NuxtでCORSエラーが発生した場合の対処も行いました。
具体的には、nuxt.config.jsで以下のようにaxiosを設定してみたり、proxyにいろいろ書き足したりしてみましたが解決しませんでした。

  axios: {    
    proxy: true,
    baseURL: 'http://localhost:5000/api/',
    proxyHeaders: false,
    credentials: false
  },

  proxy: {
    '/api/': {
      target: 'http://localhost:5000',
      pathRewrite: {'^/api': '/'}
    }
  },

もちろんFlask側で CORS(app, resources={'/api/*': {'origins': '*'}}) のようなことはしているのですが原因が全くわかりません。

なにか少しでも手がかりになることがあればよろしくお願いいたします。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 2

0

APIをどこか一つにまとめておきたいのですが、その場合のベストプラクティス

API をまとめるのは、Vuex を利用するのはいかがでしょうか。
下記リファレンスにAPIの抽象化まで含めたサンプルが載っています。
https://vuex.vuejs.org/ja/guide/structure.html

CORSについて

axios から投げるリクエストのヘッダーに、 Access-Control-Allow-Origin: https://{apiuri}.com は含まれていますか?

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

0

ベストプラクティスはわかりませんが最近勉強を始めた私はこんな感じで切り出してます

/nuxtapp/
  /services
    xxxx.js 
  # vueから呼ばれてapi-facadeでの通信を含むビジネスロジックを行い
  # 必要があればvuexのmutationを呼び出し結果保存
  /api
    api-facade.js # axiosのインスタンスをdaoに渡してdaoを呼び出す
    /dao
      xxxx-dao.js # 渡されたaxiosでAPIを呼び出す
  /store
    xxxx.js # api通信結果を格納するvuex

みたいな感じで実装してみましたー。

CORSについてはわかりません!

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 88.82%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る