Exemple OpenAPI
Découvrez une page d'endpoint générée en direct depuis OpenAPI et apprenez comment Jamdesk affiche les requêtes, réponses et l'authentification directement depuis votre spec.
Créer un nouveau ticket pour un problème ou une demande client.
Body
customer_idstringrequiredIdentifiant du client dans Acme.
subjectstringrequiredRésumé court du problème.
priority"low" | "normal" | "high" | "urgent""low" | "normal" | "high" | "urgent"tagsarray<string>messagestringrequiredDescription détaillée du problème.
Response
Ticket créé
idstringcustomer_idstringsubjectstringprioritystringstatus"open" | "pending" | "resolved""open" | "pending" | "resolved"tagsarray<string>messagestringcreated_atstring<date-time>updated_atstring<date-time>Cette page illustre un endpoint généré en direct depuis une spécification OpenAPI. 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.
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.
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.
Cette page a le playground API activé. Cliquez sur Try it sur l'endpoint ci-dessus pour tester l'API en direct.
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 pour tous les détails.