Activer « Essayer » · Documentation Specistry

Laissez les lecteurs appeler votre API depuis leur navigateur — et uniquement de là.

Activer « Essayer »

0:00 / 0:13

specistry.config.ts

environments: {
  sandbox: { label: "Sandbox", baseUrl: "https://sandbox.testinbox.email" },
  production: { baseUrl: "https://api.testinbox.email" },
  local: { baseUrl: "http://localhost:8080" },
},
playground: {
  mode: "browser",
  environments: ["sandbox", "local"],
  timeoutMs: 15000,
},

HTTPS obligatoire, sauf HTTP en boucle locale pour le développement
Les identifiants restent en mémoire du navigateur, jamais stockés
En-têtes interdits bloqués ; une redirection ne peut pas contourner la politique
Déclarer un environnement pour les exemples ne l’autorise pas pour l’exécution

AttentionLe CORS relève de votre API

Votre API doit autoriser l’origine de la documentation. Specistry ne fournit aucun proxy pour contourner cette règle.

Cas particuliers

HTTP vers un hôte distant

Refusé par la politique

✕ ÉCHOUE

specistry.config.ts

staging: { baseUrl: "http://staging.acme.dev" }

✓ CORRECTION

specistry.config.ts

staging: { baseUrl: "https://staging.acme.dev" }

Seule la boucle locale peut utiliser HTTP.

La requête échoue dans le navigateur

Erreur réseau

✕ ÉCHOUE

console du navigateur

blocked by CORS policy

✓ CORRECTION

en-têtes de réponse de l’API

Access-Control-Allow-Origin: https://docs.acme.dev

L’API n’autorise pas l’origine de la doc.