De la spécification à l’expérience développeur.
Specistry transforme vos contrats d’API et vos guides en un portail développeur rapide et accessible — généré à l’avance, servi depuis votre infrastructure.
Attendre un message
Plutôt que d’interroger en boucle, attendez qu’un message correspondant arrive. Le guide renvoie directement vers l’opération utilisée.
Attendre un message
POST /v1/inboxes/{id}/messages/waitBloque jusqu’à l’arrivée d’un message correspondant au filtre, ou jusqu’à expiration du délai.
subjectstring · regexfromstring · optionaltimeoutinteger · msMessage
Renvoyé par toutes les opérations sur les messages. Les liens sont déjà extraits du corps HTML.
idstringsubjectstringlinksarray of stringhtmlstring · nullableAttendre un message
POST /v1/inboxes/{id}/messages/waitLe panneau suit la section que vous lisez.
Guides et référence, enfin réunis.
Les guides rédigés et la référence API générée partagent la même navigation, le même index de recherche et la même mise en page. Un guide renvoie vers l’opération exacte ; l’opération renvoie vers le guide qui l’explique.
Vos specs, vos contenus, votre configuration — compilés en une seule expérience.
- Guides
- Référence
- Recherche
- Code
- Essayer
- Versions
Six exemples de protocole. Une seule requête de référence.
Les exemples de protocole sont générés à partir de l’opération réelle : ils ne peuvent pas diverger. Les exemples SDK n’apparaissent que si vous déclarez explicitement votre vrai SDK — Specistry n’invente jamais une API que vous ne livrez pas.
const inbox = await client.inboxes.create({
ttl: 3600
});Déclaré par l’auteur · sdk.ts → inboxes.create
Les requêtes partent du navigateur du développeur vers votre API. Nulle part ailleurs.
Specistry n’embarque aucun proxy de requêtes. Vous déclarez les origines exactes que les développeurs peuvent appeler ; les identifiants restent dans la mémoire du navigateur.
- Origines autorisées explicitement
- Identifiants en mémoire uniquement
- Aucun proxy de requêtes Specistry
Cherchez dans votre documentation, pas chez un service tiers.
L’index est généré au build. Les recherches restent dans le navigateur.
Chaque version publiée est figée.
Une URL v1 décrit toujours la v1. Passer la v3 en version courante ne réécrit jamais le passé. Les évolutions du contrat apparaissent dans un changelog structuré que vous relisez — Specistry ne publie jamais de texte généré de lui-même.
- v1reste v1 · 2025-09
- v2reste v2 · 2026-03
- v3courante
npm i -D @specistry/cli: installé · @specistry/clinpx specistry validate: configuration · 14 pages · 11 opérations · 3 SDK déclarésnpx specistry build: documentation · 2,1 s · artefact → .specistry/artifactsnpx specistry check: contrôle qualité · 0 lien cassé · 0 opération non couvertenpx specistry release: version immuable créée · versions précédentes inchangées
Traitez la documentation comme de l’infrastructure.
Validez la configuration, construisez le site et contrôlez la qualité dans le même pipeline que votre code. Tout le travail lourd se fait en amont ; les lecteurs reçoivent des pages prêtes à servir.
@specistry/cli sur npm →Votre documentation. Votre périmètre de déploiement.
- Aucun SaaS de recherche imposé
- Aucun proxy d’API générique
- Aucune télémétrie par défaut
- Des sources portables
- Dépôt
- Specistry build
- Votre infrastructure
- Développeurs
Ce qui est inclus
Guides
Markdown/MDX rédigé, avec la même navigation et la même recherche que la référence.
Référence API
Opérations et schémas complexes normalisés depuis OpenAPI.
Recherche
Index généré au build, interrogé dans le navigateur.
Code & SDK
Six exemples de protocole générés ; exemples SDK uniquement depuis vos déclarations.
Essayer
Requêtes directes du navigateur vers les origines autorisées. Sans proxy.
Versions et changelog
Versions figées, URL historiques fiables, changelogs relus.