Exemples de code et SDK
Les exemples de protocole sont générés ; les exemples SDK, c’est vous qui les déclarez.
0:00 / 0:16
Chaque opération affiche des exemples cURL, HTTP, JavaScript, TypeScript, Java et Python générés à partir de l’opération canonique. Changer d’environnement ne modifie que l’URL de base autorisée ; les identifiants restent des valeurs fictives.
Déclarer un SDK
sdks: [{
id: "ts",
label: "TypeScript",
language: "typescript",
package: "@testinbox/client",
examples: [{
operation: "createInbox",
code: "const inbox = await client.inboxes.create({ ttl: 3600 });",
}],
}],Du code dans les guides
Les blocs de code sont colorés au moment du build. title="…" est le seul attribut accepté.
```typescript title="inscription.test.ts"
const inbox = await client.inboxes.create({ ttl: 600 });
```Pour la même commande dans plusieurs outils, utilisez CodeGroup : chaque titre de bloc devient un onglet.
<CodeGroup>
```bash title="npm"
npm install @testinbox/client
```
```bash title="pnpm"
pnpm add @testinbox/client
```
</CodeGroup>Cas particuliers
Attributs en trop sur un bloc
CONTENT_COMPONENT_PROP_INVALID✕ ÉCHOUEdocs/x.md
```ts title="a.ts" highlight="2"✓ CORRECTIONdocs/x.md
```ts title="a.ts"Seul `title` est accepté.
Langage inconnu
Aucun diagnostic✕ ÉCHOUEdocs/x.md
```hcl✓ CORRECTIONdocs/x.md
```tomlLe bloc s’affiche en texte brut. Choisissez un alias pris en charge s’il convient.
Pas encore de SDK
Trompeur✕ ÉCHOUEspecistry.config.ts
sdks: [{ id: "ts", examples: [] }]✓ CORRECTIONspecistry.config.ts
// omettez simplement sdksLes lecteurs croiront qu’un client existe.