Un projet. Plusieurs chapitres.
Outil devOpen source · MITCréé en

Specanto.

Comprendre ce qu’une API attend, ce qu’elle renvoie et comment l’appeler : une référence OpenAPI interactive, intégrable dans une application React.

Mon rôle

Conception et développement de la bibliothèque, du moteur TypeScript et de son CLI, puis intégration dans MoodDish.

ReactTypeScriptOpenAPIViteToute la stack
Specanto, intégré à la documentation de MoodDish.Cliquer sur les captures pour agrandir
Feuilletons ensemble

Une idée.
Tout un parcours.

Fais défiler pour découvrir
ce qui se passe à l’intérieur.

La référence API dans MoodDish

01 / 03Lire le contrat

Une API qui se laisse explorer.

Specanto transforme un document OpenAPI en une interface lisible : les routes, leurs paramètres et leurs réponses restent réunis dans le même espace.

  • Naviguer par groupes et retrouver une opération avec la recherche.
  • Lire les paramètres, les schémas et les exemples de réponse sans quitter la documentation.

La référence API dans MoodDish

02 / 03Préparer l’appel

Du contrat à la requête.

La console permet de renseigner les paramètres et de préparer un appel HTTP. Les exemples de code suivent le formulaire, pour passer de la documentation à son propre projet.

  • Préparer les paramètres et les en-têtes, puis déclencher volontairement une requête.
  • Copier un exemple cURL, Fetch ou Python ; les en-têtes secrets connus sont masqués par défaut.

La console et l’exemple Fetch

03 / 03Construire un outil réutilisable

De la bibliothèque à mes projets.

J’ai conçu Specanto comme un package React, puis je l’ai intégré à la documentation de MoodDish. Le CLI prépare une application Vite et un document OpenAPI à adapter à son backend.

  • Installer @specanto/react depuis npm et lui fournir sa propre spécification OpenAPI.
  • Retrouver la documentation sur ordinateur et mobile, avec une interface configurable en français ou en anglais.

Les visuels montrent des routes publiques documentées de MoodDish et des exemples issus des schémas OpenAPI.

L’intégration MoodDish sur mobile

Du produit au code

Sous la
couverture.

Une référence API responsive avec recherche, schémas et console HTTP, des exemples cURL, Fetch et Python, une comparaison de spécifications et un CLI pour démarrer une documentation locale. La bibliothèque est publiée sur npm et intégrée à la documentation de MoodDish.

01

Contrat API

Document OpenAPI 3.0 / 3.1, fourni en JSON, YAML ou par URL

02

Moteur

TypeScript : lecture des schémas, construction des requêtes et comparaison des contrats

03

Interface

Composants React : référence API, console HTTP et comparaison de spécifications

04

Distribution

Package npm sous licence MIT · CLI pour une app Vite · API de démonstration Bun

Un moteur séparé de l’interface

Le cœur TypeScript n’importe pas React. Il normalise le sous-ensemble OpenAPI pris en charge et construit les requêtes utilisées par la console et les exemples de code. La bibliothèque s’intègre à une application existante ; le serveur Bun appartient à la démo.

Repérer les changements de contrat

Le composant de comparaison lit deux fichiers JSON ou YAML et confronte leurs opérations, paramètres, schémas et exigences d’authentification. Le moteur classe les changements et signale les ruptures potentielles dans le périmètre qu’il sait comparer.

Une intégration concrète dans MoodDish

L’app de documentation MoodDish importe ApiReference depuis @specanto/react et charge son fichier OpenAPI local. Le CLI fournit aussi un starter Vite avec un proxy de développement ; la spécification reste un document à renseigner, sans détection automatique des routes backend.

La stack
  • React
  • TypeScript
  • OpenAPI
  • Vite
  • Bun
L’histoire continue

Un projet à
écrire ensemble ?

On en parle