如何实现这样的 axios API 查询参数？

Question

This is the first time I found an API like this, the form in the params key is like an array but maybe it's not an array and how is it implemented in axios?

{baseUrl}/list?filter[v3_p.name]=Package Data&filter[pro.name]=Indosat&filter[pp.category]=Voucher&filter[pd.is_enable]=1

My code in axios like this:

export const filterProduk = (data) => async (dispatch) => {
  try {
    const params = { filter: data }
    const res = await axios.get(`${baseUrl}/list`, data, {
      params,
      paramsSerializer: function paramsSerializer(params) {
        return Object.entries(Object.assign({}, params, { filter: 'HIDDEN' })).map(([key, value]) => `${key}=${value}`).join('&')
      }
    });
    dispatch({
      type: FILTER_SUCCESS,
      payload: res.data.data
    });
  } catch (error) {
    dispatch({
      type: FILTER_FAILED,
      payload: error.response.data,
    });
  }
};

and I have tried as well

export const filterProduk = (data) => async (dispatch) => {
  try {
    const res = await axios.get(`${baseUrl}/list`, data, {
      params: {
        filter: [data.package, data.provider, data.category, data.is_enable]
      }
    });
    dispatch({
      type: FILTER_SUCCESS,
      payload: res.data.data
    });
  } catch (error) {
    dispatch({
      type: FILTER_FAILED,
      payload: error.response.data,
    });
  }
};

I don't get it in any documentation, and hope to get an answer here! Thankyou

Answer 1

You can use qs.stringify to serialize the params. And you should pass the config object as the second argument to axios.get .

axios.get(`${baseUrl}/list`, {
  params,
  paramsSerializer: (params) => qs.stringify(params, { encode: false }),
})

---

A suggestion: You could set up the API base URL using axios.defaults.baseURL or create a custom axios instance and configure it to avoid having to type it in every call.

// axios.js

import axios from 'axios'

export default axios.create({
  baseURL: 'https://api.example.com'
})

// queries.js

import axios from './axios'

axios.get('/list', {
  params,
  paramsSerializer: (params) => qs.stringify(params, { encode: false }),
})