Le client API

Envoyer des requêtes HTTP et GraphQL, ouvrir des WebSockets, les ranger en collections, et les faire varier d’un environnement à l’autre.

Vérifié sur DevNotes 0.12

La zone HTTP (Ctrl3) garde vos requêtes en collections, scellées comme vos notes. Une requête part vers le serveur que vous nommez, et nulle part ailleurs.

Commencer une requête

+ Nouvelle requête, au bout des onglets ou dans le menu d’une collection, demande ce que vous commencez :

  • Requête HTTP : une méthode, une URL, des en-têtes et un corps.
  • Requête GraphQL : une requête et ses variables, envoyées en POST.
  • WebSocket : une connexion ouverte, des messages dans les deux sens.

Chaque requête s’ouvre dans un onglet. CtrlEntrée l’envoie (ou connecte le WebSocket), CtrlS l’enregistre dans une collection.

Les parties d’une requête

  • Paramètres et En-têtes : des tables clé / valeur, chaque ligne activable. Ceux que DevNotes ajoute de lui-même sont montrés à part.
  • Auth : Héritée, Aucune, Basic, Bearer ou Clé d’API, envoyée dans un en-tête ou dans la query.
  • Corps : JSON, texte, formulaire, multipart ou fichier. Un fichier est lu au moment de l’envoi, ses octets ne sont jamais gardés.
  • Réglages : le délai d’attente, les redirections, la vérification des certificats TLS et les cookies.

La réponse

Le statut, la durée et la taille, puis le corps Formaté ou Brut ; un JSON se lit aussi en Graphe ou en Arbre. À côté, les En-têtes, les Cookies posés et la Chronologie de l’échange. Une réponse s’enregistre dans un fichier ou se garde comme une note.

Collections et dossiers

Une collection range des requêtes, éventuellement en dossiers. Ses Réglages… passent à ses requêtes : une requête dont l’auth est Héritée prend celle de son dossier ou de sa collection, et leurs en-têtes s’ajoutent aux siens.

Dans le rail des collections
TouchesAction
Alt↑↓Déplacer une ligne parmi ses voisines
Alt→La ranger dans le dossier juste au-dessus
Alt←La sortir de son dossier
F2Renommer
SupprSupprimer, après confirmation

Variables et environnements

Une variable s’écrit entre doubles accolades, n’importe où dans la requête :

Une URL qui varie selon l’environnement
GET {{base_url}}/v1/invoices?status=paid

Elle est résolue au moment de l’envoi, du plus proche au plus lointain : la requête, son dossier, sa collection, l’environnement actif, puis les globales. Sous l’URL, chaque nom montre d’où vient sa valeur. Un nom que rien ne définit bloque l’envoi plutôt que de partir tel quel, et Définir dans … ouvre l’endroit où le définir.

  1. Gérer les environnements… crée Local, Staging, Production : chacun un jeu de variables, avec une couleur.
  2. L’environnement actif se choisit au bout des onglets. Aucun garde les globales seules.
  3. Une variable est du Texte, un Nombre ou un Secret : un secret est masqué à l’écran et n’est jamais écrit dans l’historique.

Un environnement protégé demande avant d’envoyer autre chose qu’un GET, un HEAD ou un OPTIONS, et avant d’ouvrir un WebSocket. Mettez-le sur la production.

Les {{champs}} d’un snippet et les variables d’une requête s’écrivent pareil, mais ne se mélangent pas : les premiers sont demandés à la copie, les secondes résolues à l’envoi.

L’historique

Chaque envoi s’inscrit dans l’Historique, chiffré comme vos notes : 30 jours, 500 envois au plus. Un envoi se relit, se rouvre dans sa requête ou en brouillon, et s’efface. Les secrets y sont masqués avant d’être écrits.

Le code d’une requête

Le bouton </> Code écrit la requête pour vingt cibles, de cURL et PowerShell à fetch, axios ou le HttpClient d’Angular. Les variables peuvent y être résolues ; les secrets restent en variables, sauf si vous demandez à les inclure.

Les WebSockets

Un WebSocket se connecte, puis échange : le journal montre chaque message envoyé et reçu, avec son heure. Les messages se gardent pour être renvoyés. Changer de bibliothèque ferme les connexions ouvertes.