Alias de requête

axios fournit un ensemble d'alias pour effectuer des requêtes HTTP. Ces alias sont des raccourcis pour effectuer des requêtes via la méthode request. Ils sont conçus pour être faciles à utiliser et offrir une façon plus pratique d'effectuer des requêtes.

axios s'efforce de suivre les RFC 7231 et RFC 5789 aussi fidèlement que possible. Les alias sont conçus pour être cohérents avec les méthodes HTTP définies dans ces RFC.

axios

axios peut être utilisé pour effectuer une requête HTTP en passant uniquement l'objet de configuration. L'objet de configuration complet est documenté ici

axios<T, R, D, P>(
  url: string | AxiosRequestConfig<D, P>,
  config?: AxiosRequestConfig<D, P>
): Promise<R>;

Les méthodes de requête utilisent les paramètres génériques dans l'ordre <T, R, D, P> : données de réponse, réponse personnalisée, données de requête et paramètres de requête. P est ajouté en dernier afin de préserver la signification des arguments explicites T, R et D. Sans R personnalisé, l'AxiosResponse par défaut conserve D et P dans response.config.

Alias de méthode

Les alias suivants sont disponibles pour effectuer des requêtes :

request

La méthode request est la méthode principale pour effectuer des requêtes HTTP. Elle accepte un objet de configuration en argument et retourne une promise qui se résout vers l'objet de réponse. C'est une méthode générique pouvant être utilisée pour tout type de requête HTTP.

axios.request<T, R, D, P>(config: AxiosRequestConfig<D, P>): Promise<R>;

get

La méthode get est utilisée pour effectuer une requête GET. Elle accepte une URL et un objet de configuration optionnel en arguments et retourne une promise qui se résout vers l'objet de réponse.

axios.get<T, R, D, P>(url: string, config?: AxiosRequestConfig<D, P>): Promise<R>;

delete

La méthode delete est utilisée pour effectuer une requête DELETE. Elle accepte une URL et un objet de configuration optionnel en arguments et retourne une promise qui se résout vers l'objet de réponse.

axios.delete<T, R, D, P>(url: string, config?: AxiosRequestConfig<D, P>): Promise<R>;

head

La méthode head est utilisée pour effectuer une requête HEAD. Elle accepte une URL et un objet de configuration optionnel en arguments et retourne une promise qui se résout vers l'objet de réponse.

axios.head<T, R, D, P>(url: string, config?: AxiosRequestConfig<D, P>): Promise<R>;

options

La méthode options est utilisée pour effectuer une requête OPTIONS. Elle accepte une URL et un objet de configuration optionnel en arguments et retourne une promise qui se résout vers l'objet de réponse.

axios.options<T, R, D, P>(url: string, config?: AxiosRequestConfig<D, P>): Promise<R>;

post

La méthode post est utilisée pour effectuer une requête POST. Elle accepte une URL, un objet de données optionnel et un objet de configuration optionnel en arguments et retourne une promise qui se résout vers l'objet de réponse.

axios.post<T, R, D, P>(url: string, data?: D, config?: AxiosRequestConfig<D, P>): Promise<R>;

put

La méthode put est utilisée pour effectuer une requête PUT. Elle accepte une URL, un objet de données optionnel et un objet de configuration optionnel en arguments et retourne une promise qui se résout vers l'objet de réponse.

axios.put<T, R, D, P>(url: string, data?: D, config?: AxiosRequestConfig<D, P>): Promise<R>;

patch

La méthode patch est utilisée pour effectuer une requête PATCH. Elle accepte une URL, un objet de données optionnel et un objet de configuration optionnel en arguments et retourne une promise qui se résout vers l'objet de réponse.

axios.patch<T, R, D, P>(url: string, data?: D, config?: AxiosRequestConfig<D, P>): Promise<R>;

query

La méthode query est utilisée pour effectuer une requête QUERY, une méthode sûre et idempotente qui transporte un corps. Elle accepte une URL, un objet de données optionnel et un objet de configuration optionnel en arguments et retourne une promise qui se résout vers l'objet de réponse. Utilisez-la pour des opérations de type lecture dont les paramètres sont trop complexes ou trop sensibles pour figurer dans l'URL.

axios.query<T, R, D, P>(url: string, data?: D, config?: AxiosRequestConfig<D, P>): Promise<R>;

// Envoyer un filtre de recherche complexe dans le corps de la requête
const { data } = await axios.query("/api/search", {
  selector: ["name", "email"],
  filter: { active: true, role: "admin" },
});

Spécification en cours d'élaboration

La méthode QUERY est définie par un Internet-Draft de l'IETF et n'a pas encore été standardisée. La sémantique et le nom même de la méthode peuvent évoluer avant la publication finale, et la prise en charge par les serveurs, proxys et CDN est inégale. Vérifiez que votre pile accepte QUERY de bout en bout avant de vous en servir en production.

getUri

La méthode getUri retourne l'URL qui serait envoyée pour une configuration donnée sans réellement effectuer la requête. Elle applique baseURL, paramsSerializer et params, vous obtenez donc la même chaîne qu'axios mettrait sur le réseau. Utile pour construire des liens, déboguer la sérialisation ou réutiliser l'URL résolue dans une autre requête.

axios.getUri(config?: AxiosRequestConfig): string;

const url = axios.getUri({
  url: "/users",
  baseURL: "https://api.example.com",
  params: { active: true, role: "admin" },
});
// "https://api.example.com/users?active=true&role=admin"

TIP

Utilisez getUri sur une instance (instance.getUri(config)) pour hériter des valeurs par défaut de l'instance pour baseURL, params et paramsSerializer.

Méthodes raccourcies pour les données de formulaire

Ces méthodes sont équivalentes à leurs homologues ci-dessus, mais prédéfinissent le Content-Type à multipart/form-data. Elles constituent la façon recommandée d'envoyer des fichiers ou de soumettre des formulaires HTML.

postForm

axios.postForm<T, R, D, P>(url: string, data?: D, config?: AxiosRequestConfig<D, P>): Promise<R>;

// Envoyer un fichier depuis un input file du navigateur
await axios.postForm("/api/upload", {
  file: document.querySelector("#fileInput").files[0],
  description: "Profile photo",
});

putForm

axios.putForm<T, R, D, P>(url: string, data?: D, config?: AxiosRequestConfig<D, P>): Promise<R>;

// Remplacer une ressource avec des données de formulaire
await axios.putForm("/api/users/1/avatar", {
  avatar: document.querySelector("#avatarInput").files[0],
});

patchForm

axios.patchForm<T, R, D, P>(url: string, data?: D, config?: AxiosRequestConfig<D, P>): Promise<R>;

// Mettre à jour des champs spécifiques avec des données de formulaire
await axios.patchForm("/api/users/1", {
  displayName: "New Name",
  avatar: document.querySelector("#avatarInput").files[0],
});

TIP

postForm, putForm et patchForm acceptent les mêmes types de données que leurs méthodes de base — objets simples, FormData, FileList et HTMLFormElement. Consultez Envoi de fichiers pour plus d'exemples.