Aller au contenu
Accueil moxon

6.1.0

API

API v6.1.0 — Nouveau nom @moxon/api, export manifest expérimental, correctifs de sécurité.

  • Le paquet @20syldev/api devient @moxon/api, sous l'organisation npm @moxon, et le dépôt vit désormais sur moxondev/api. L'ancien paquet n'évolue plus ; la 6.1.0 est la première version stable publiée sous le nouveau nom. L'API HTTP /v6 est inchangée : pour migrer, il suffit de lancer npm uninstall @20syldev/api && npm install @moxon/api, puis de renommer vos imports — les sous-chemins sont identiques. Le détail se trouve dans le guide de migration.
  • Nouvel export @moxon/api/manifest, expérimental : il expose manifest, un tableau typé ManifestEntry[] qui décrit les endpoints sous forme de données — nom, méthode, chemin, catégorie, première version qui le sert (since), paramètres et exemple de requête — sans la fonction qui les exécute. Il s'adresse aux outils qui documentent ou appellent l'API. Seul hash y figure pour l'instant, et sa forme peut encore évoluer dans une version mineure. Voir la page Manifest. Expérimental
  • L'endpoint POST /hash est le premier à être déclaré comme un contrat : la même déclaration construit sa route HTTP et son entrée du manifest, si bien que les deux ne peuvent plus diverger. Son comportement ne change pas : mêmes paramètres, mêmes erreurs, mêmes résultats de v4 à v6.
  • /favicon.ico n'est plus servi par l'API : le fichier quitte aussi le paquet, qui s'allège d'environ 250 ko.
  • Des dépendances sont mises à jour pour des correctifs de sécurité : proxy-addr, utilisé par Express (faille critique d'usurpation d'adresse IP via un sous-réseau de confiance IPv6 mappé en IPv4), et brace-expansion, présent uniquement dans l'outillage de développement. Ces versions sont fixées dans le package-lock.json du dépôt : elles protègent les clones et les déploiements faits avec npm ci.

Documentation

  • La documentation est désormais hébergée sur moxon.dev.
  • Nouveau site de documentation, reconstruit avec Next.js : catalogue de 49 endpoints en 7 catégories, palette de recherche au clavier avec les filtres post: et get:, thème sombre et affichage adapté au téléphone.
  • Les adresses des pages changent : /v6/hash en anglais et /fr/v6/hash en français. Les anciennes adresses (/v6/fr/hash, /v6/en/hash) redirigent automatiquement vers les nouvelles.
  • Les ancres des titres sont désormais identiques dans les deux langues (#response-fields) ; les anciens fragments français sont redirigés.
  • L'exemple de la page d'accueil n'appelle plus l'API à chaque visite.
  • La page d'accueil n'affiche plus les cartes de version : le sélecteur de version de l'en-tête les remplace.
  • Ajout de la page Manifest, qui présente l'export expérimental @moxon/api/manifest. Expérimental
  • Ajout d'une section d'installation sur la page Commencer, avec npm install @moxon/api et les points d'entrée du paquet.
  • Ajout d'un guide de migration depuis @20syldev/api sur la page Changelog : les commandes, la table de renommage des imports et la note sur v1–v3.
  • Correction de la documentation du Tic-Tac-Toe : POST /tic-tac-toe répond 404 en v6 depuis la 6.0.0, mais figurait encore comme endpoint principal du jeu. La page, la sidebar et le Playground s'appuient désormais sur les routes /tic-tac-toe/play, /tic-tac-toe/forfeit, /tic-tac-toe/fetch et /tic-tac-toe/list. Le tableau de migration de la page Changelog liste aussi le passage de POST /tic-tac-toe à POST /tic-tac-toe/play.
  • Précision sur la page Infos de ce que compte le champ endpoints : les chemins distincts de la version demandée, si bien que GET /chat et POST /chat ne comptent que pour un.
  • Ajout du champ encoding aux champs de réponse de POST /hash.