Document de découverte
const url = 'https://api-equides.org/';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}use reqwest;
#[tokio::main]pub async fn main() { let url = "https://api-equides.org/";
let client = reqwest::Client::new(); let response = client.get(url) .send() .await;
let results = response.unwrap() .json::<serde_json::Value>() .await .unwrap();
dbg!(results);}curl --request GET \ --url https://api-equides.org/Le point d’entrée : routes servies, gabarits d’URL, licence et provenance. Un client qui ne connaît que cette URL y trouve de quoi construire toutes les autres. La documentation destinée aux humains vit sur https://docs.api-equides.org.
Responses
Section intitulée « Responses »Document de découverte.
Document de découverte servi à la racine sur Accept: application/json.
object
Routes servies, par usage.
object
Publiés ici une fois pour toutes : aucune réponse ne répète un lien déductible d’un identifiant.
object
Examplegenerated
{ "affiliation": "example", "description": "example", "documentation": "example", "endpoints": { "additionalProperty": "example" }, "gabarits_url": { "additionalProperty": "example" }, "licence_donnees": "example", "lignes": 1, "nom": "example", "openapi": "example", "source": "example", "version": "example"}Contenu inchangé depuis l’ETag fourni en If-None-Match. Aucun corps, et rien n’est recalculé côté service.
Quota de débit dépassé pour l’adresse appelante. Retry-After indique le délai.
Corps d’erreur conforme à la RFC 9457 (« Problem Details for HTTP APIs »), servi en application/problem+json. Les champs parametre et indice sont des extensions, que la RFC autorise.
object
Explication propre à cette occurrence.
Extension : piste de correction — valeurs admises, référentiel à consulter, ou paramètre le plus proche en cas de faute de frappe.
Extension : paramètre fautif, quand l’erreur en désigne un.
Résumé lisible, stable pour un type donné.
URI du type de problème, relative — le client la résout contre l’URI de la requête. Elle pointe vers la section correspondante de la documentation.
Example
{ "detail": "paramètre inconnu `rase`", "documentation": "https://docs.api-equides.org", "indice": "vouliez-vous dire `race` ?", "parametre": "rase", "status": 400, "title": "Paramètre invalide", "type": "/#erreur-parametre-invalide"}Capacité de traitement simultané atteinte, délai maximal dépassé, ou données non chargées. Retry-After indique le délai.
Corps d’erreur conforme à la RFC 9457 (« Problem Details for HTTP APIs »), servi en application/problem+json. Les champs parametre et indice sont des extensions, que la RFC autorise.
object
Explication propre à cette occurrence.
Extension : piste de correction — valeurs admises, référentiel à consulter, ou paramètre le plus proche en cas de faute de frappe.
Extension : paramètre fautif, quand l’erreur en désigne un.
Résumé lisible, stable pour un type donné.
URI du type de problème, relative — le client la résout contre l’URI de la requête. Elle pointe vers la section correspondante de la documentation.
Example
{ "detail": "paramètre inconnu `rase`", "documentation": "https://docs.api-equides.org", "indice": "vouliez-vous dire `race` ?", "parametre": "rase", "status": 400, "title": "Paramètre invalide", "type": "/#erreur-parametre-invalide"}