Un portail développeur qui ne peut pas dériver de votre API.
Cela remplace la documentation ReadMe ou GitBook qui devient obsolète des semaines après le lancement. Montrez-lui votre spécification OpenAPI et vos dépôts SDK. Il analyse les points de terminaison, extrait de vrais extraits de code, et publie un site de référence sous votre domaine, avec le même en-tête et pied de page que votre site marketing. La référence est en aval de votre source, elle reste donc à jour.
Une documentation en aval de la source de vérité
Les guides sont le seul contenu qu'un humain rédige. Les pages de référence sont générées, elles ne peuvent donc pas se désynchroniser de l'API réelle.
Vers votre spec et vos dépôts
Donnez-lui une URL de spécification OpenAPI et vos dépôts SDK TypeScript et Python dans les paramètres.
Points de terminaison, schémas et méthodes
Il indexe chaque point de terminaison en groupes d'API par étiquette, extrait les paramètres et les schémas de réponse, et récupère les méthodes et signatures de la source de votre SDK.
Extraits aux points de terminaison
Les méthodes du SDK sont associées aux points de terminaison par méthode HTTP et chemin, et des exemples cURL sont générés à partir des définitions.
Resynchronisé depuis la source
La référence d'API se resynchronise depuis votre spec sur un horaire, et les extraits SDK depuis vos dépôts, si bien qu'un nouveau point de terminaison ou une nouvelle méthode apparaît sans que personne n'édite la documentation.
Deux types de synchronisation
Synchronisation OpenAPI
Points de terminaison organisés en groupes par étiquette, avec paramètres, corps de requête et schémas de réponse extraits et affichés. Déclenchez une synchronisation à la main, ou laissez-la s'exécuter sur un horaire ; l'état de synchronisation et un journal d'événements complet avec détails d'erreur sont là quand quelque chose échoue.
Synchronisation SDK
Configurez des dépôts GitHub pour vos SDK TypeScript (npm) et Python (PyPI). Le système clone le dépôt, analyse la source, et stocke les extraits de code par langage avec les références de fichier et de ligne, en suivant le SHA du commit pour éviter les synchronisations redondantes.
De vrais extraits, tirés de vos dépôts
Chaque page de point de terminaison montre un exemple cURL et les extraits SDK associés côte à côte. Ceux-ci sont illustratifs ; sur votre portail, le code est extrait de votre source réelle, avec le fichier et la ligne d'origine.
cURL
curl https://api.yourcompany.com/v1/contacts \ -H "Authorization: Bearer $YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "email": "ada@example.com", "name": "Ada Lovelace" }'client.ts
import { YourApi } from "@yourcompany/sdk";
const api = new YourApi({ apiKey: process.env.YOUR_API_KEY });
const contact = await api.contacts.create({ email: "ada@example.com", name: "Ada Lovelace",});L'authentification de votre API, montrée aux développeurs
Configurez les méthodes que votre API accepte, et elles apparaissent dans la référence pour que les développeurs sachent exactement comment s'authentifier.
Clé d'API
La voie la plus simple, montrée dans la référence.
HTTP
Authentification Bearer ou Basic.
OAuth 2.0
Pour les portails nécessitant un accès délégué.
OpenID Connect
L'identité au-dessus d'OAuth, documentée pour les développeurs.
Une plateforme, une marque, un domaine
La plupart des entreprises orientées développeurs gardent la documentation sur ReadMe, le site marketing sur Webflow, et le blog sur WordPress, et personne ne maintient rien. Ici, le portail partage une marque, un domaine, et les mêmes en-tête et pied de page que votre site marketing et votre base de connaissances. Un développeur qui arrive sur votre référence d'API et clique sur Tarifs ne quitte pas votre site pour un autre outil.
La même IA qui rédige votre texte marketing rédige vos guides développeurs, dans la même voix, ancrée dans le même contexte d'entreprise. Pour une équipe déjà sur Giant Context, ajouter un portail est une page de paramètres, pas une décision d'achat. Et l'agent de chat peut répondre aux questions des développeurs en s'appuyant sur votre référence et vos guides.
Où sont les limites
Montrez-lui votre spec et lisez la référence
Demandez un accès anticipé. Donnez au portail une spécification OpenAPI et un dépôt SDK, lancez une synchronisation, et parcourez un site de référence qui reflète votre API réelle — sous votre propre domaine.