Primeros pasos

¡Bienvenido a la documentación de axios! Esta guía te ayudará a comenzar con axios y a realizar tu primera solicitud a una API. Si eres nuevo en axios, te recomendamos empezar aquí.

Instalación

Puedes usar axios en tu proyecto de varias formas. La más común es instalarlo desde npm e incluirlo en tu proyecto. También ofrecemos soporte para jsDelivr, unpkg y más.

Usando npm

npm install axios

Usando pnpm

pnpm install axios

Usando yarn

yarn add axios

Usando bun

bun add axios

Usando deno

deno install npm:axios

Usando jsDelivr

Al usar jsDelivr, recomendamos utilizar la versión minificada y fijar el número de versión para evitar cambios inesperados. Si deseas usar la última versión, puedes hacerlo omitiendo el número de versión. Esto está fuertemente desaconsejado para uso en producción, ya que puede ocasionar cambios inesperados en tu aplicación.

<script src="https://cdn.jsdelivr.net/npm/axios@<x.x.x>/dist/axios.min.js"></script>

Usando unpkg

Al usar unpkg, recomendamos utilizar la versión minificada y fijar el número de versión para evitar cambios inesperados. Si deseas usar la última versión, puedes hacerlo omitiendo el número de versión. Esto está fuertemente desaconsejado para uso en producción, ya que puede ocasionar cambios inesperados en tu aplicación.

<script src="https://unpkg.com/axios@<x.x.x>/dist/axios.min.js"></script>

Importación de axios

Una vez instalado, puedes importar la librería usando import o require:

import axios, { isCancel, AxiosError } from "axios";

También puedes usar la exportación por defecto, ya que las exportaciones nombradas son simplemente re-exportaciones desde la fábrica de axios:

import axios from "axios";

console.log(axios.isCancel("something"));

Si usas require para importar, solo está disponible la exportación por defecto:

const axios = require("axios");

console.log(axios.isCancel("something"));

Para algunos bundlers y linters de ES6 puede que necesites:

import { default as axios } from "axios";

Para entornos personalizados o heredados donde la resolución de módulos no se comporta correctamente, puedes importar el bundle preconstruido directamente:

const axios = require("axios/dist/browser/axios.cjs"); // bundle CommonJS para navegador (ES2017)
// const axios = require("axios/dist/node/axios.cjs"); // bundle CommonJS para node (ES2017)

Tu primera solicitud

Una solicitud con axios puede realizarse en tan solo dos líneas de código. Hacer tu primera solicitud con axios es muy sencillo. Puedes hacer una solicitud a cualquier API indicando la URL y el método. Por ejemplo, para hacer una solicitud GET a la API de JSONPlaceholder, puedes usar el siguiente código:

import axios from "axios";

const response = await axios.get(
  "https://jsonplaceholder.typicode.com/posts/1"
);

console.log(response.data);

axios ofrece una API sencilla para realizar solicitudes. Puedes usar el método axios.get para hacer una solicitud GET, el método axios.post para hacer una solicitud POST, y así sucesivamente. También puedes usar el método axios.request para hacer una solicitud con cualquier método.

Establece un timeout en producción

Sin un timeout, una solicitud detenida puede colgarse indefinidamente. Pásalo en la configuración de la solicitud:

const response = await axios.get("https://example.com/data", {
  timeout: 5000, // 5 segundos
});

Consulta timeout en la configuración de solicitud y Manejo de errores para los códigos ECONNABORTED / ETIMEDOUT correspondientes.

Próximos pasos

Ahora que has realizado tu primera solicitud con axios, estás listo para explorar el resto de la documentación. Puedes aprender más sobre cómo hacer solicitudes, manejar respuestas y usar axios en tus proyectos. Consulta el resto de la documentación para saber más.