---
title: Exemple OpenAPI
description: "Découvrez une page d'endpoint générée en direct depuis OpenAPI et comment Jamdesk affiche les requêtes, réponses et l'authentification depuis votre spec."
openapi: /openapi/example-api.yaml POST /tickets
---

Cette page illustre un endpoint généré en direct depuis une [spécification OpenAPI](https://spec.openapis.org/oas/latest.html). Le schéma de requête, les modèles de réponse et les exemples de code dans le panneau de droite sont tous auto-générés depuis la spec, sans aucune rédaction manuelle.

<Info>
Cet exemple utilise l'API Acme Support. Mettez à jour `api.openapi` dans votre `docs.json` pour pointer vers votre propre fichier spec et générer de vrais endpoints.
</Info>

<Info>
**Documentation multilingue ?** Fournissez un fichier `<spec>.<lang>.<ext>` à côté de votre spec source (par exemple, `example-api.fr.yaml`) et Jamdesk affiche la version traduite lorsque les utilisateurs consultent la page sous `/fr/...`. Voir [Traduire les specs OpenAPI](/fr/setup/languages#traduction-des-specs-openapi).
</Info>

<Tip>
Cette page a le [playground API](/fr/api-reference/playground) activé. Cliquez sur **Try it** sur l'endpoint ci-dessus pour tester l'API en direct.
</Tip>

## Ce qui est généré

À partir d'une seule ligne `openapi` dans le frontmatter, Jamdesk génère automatiquement :

- Un badge d'endpoint affichant la méthode et le chemin avec un code couleur
- La documentation des paramètres pour les paramètres de chemin, de requête, d'en-tête et de corps
- Les schémas de requête et de réponse, y compris les objets imbriqués et les tableaux
- Des exemples de code en cURL, Python, JavaScript, Go, Ruby, C#, Java, Rust et PHP (configurable via `api.examples.languages`)
- Les détails d'authentification extraits des schémas de sécurité de la spec

Toutes les références `$ref` dans votre spec sont automatiquement résolues, vous pouvez donc organiser vos schémas avec `components/schemas` comme d'habitude.

## Configurer OpenAPI

Placez votre spec OpenAPI 3.x (YAML ou JSON) dans le répertoire `openapi/`, enregistrez-la dans `docs.json` sous `api.openapi`, puis ajoutez `openapi: /openapi/your-spec.yaml METHOD /path` au frontmatter de n'importe quelle page. Consultez le [guide de configuration OpenAPI](/fr/setup/directory-structure#openapi) pour tous les détails.

## Pages associées

<Columns cols={2}>
  <Card title="Playground API" icon="flask-vial" href="/fr/api-reference/playground">
    Activez les tests API interactifs sur vos pages d'endpoint
  </Card>
  <Card title="Exemples de requête/réponse" icon="code" href="/fr/api-reference/request-response-examples">
    Exemple d'endpoint rédigé manuellement avec des composants MDX
  </Card>
</Columns>

<Columns cols={2}>
  <Card title="Configuration OpenAPI" icon="file-code" href="/fr/setup/directory-structure#openapi">
    Où stocker et référencer les fichiers OpenAPI
  </Card>
  <Card title="Référence docs.json" icon="file-lines" href="/fr/config/docs-json-reference">
    Référence de configuration complète incluant api.openapi
  </Card>
</Columns>