axios query传数组参数的格式

发布时间:2024年01月17日

在 Axios 中,当你需要传递数组参数时,可以使用以下几种方式进行格式化:

  1. 使用?paramsSerializer 将数组转换为逗号分隔的字符串:
    import axios from 'axios';
    
    import qs from 'qs';
    
    const arrayParams = ['param1', 'param2', 'param3'];
    
    axios.get('https://api.example.com/endpoint', {
    
    params: { array: arrayParams },
    
    paramsSerializer: (params) => qs.stringify(params, { arrayFormat: 'comma' }),
    
    })
    
    .then((response) => console.log(response))
    
    .catch((error) => console.error(error));

    这将发送一个类似于以下的请求:?https://api.example.com/endpoint?array=param1,param2,param3?

  2. 使用?indices?格式(默认行为):
    axios.get('https://api.example.com/endpoint', {
    
    params: { array: arrayParams },
    
    })
    
    .then((response) => console.log(response))
    
    .catch((error) => console.error(error));

    这将发送一个类似于以下的请求:?https://api.example.com/endpoint?array[0]=param1&array[1]=param2&array[2]=param3?

  3. 使用?brackets?格式:
    axios.get('https://api.example.com/endpoint', {
    
    params: { array: arrayParams },
    
    paramsSerializer: (params) => qs.stringify(params, { arrayFormat: 'brackets' }),
    
    })
    
    .then((response) => console.log(response))
    
    .catch((error) => console.error(error));

    这将发送一个类似于以下的请求:?https://api.example.com/endpoint?array[]=param1&array[]=param2&array[]=param3?

  4. 使用?repeat?格式:
    axios.get('https://api.example.com/endpoint', {
    
    params: { array: arrayParams },
    
    paramsSerializer: (params) => qs.stringify(params, { arrayFormat: 'repeat' }),
    
    })
    
    .then((response) => console.log(response))
    
    .catch((error) => console.error(error));

    这将发送一个类似于以下的请求:?https://api.example.com/endpoint?array=param1&array=param2&array=param3?

    注意,使用 paramsSerializer 需要安装并导入 qs 库。你可以使用以下命令安装它:

    npm install qs

    yarn add qs

文章来源:https://blog.csdn.net/daipianpian/article/details/135642192
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。