Exemple OpenAPI
Découvrez une page d'endpoint générée en direct depuis OpenAPI et voyez comment Jamdesk affiche les requêtes, les réponses et l'authentification directement depuis votre spec.
Create a new ticket for a customer issue or request.
Body
customer_idstringrequiredCustomer identifier in Acme.
subjectstringrequiredShort summary of the issue.
priority"low" | "normal" | "high" | "urgent""low" | "normal" | "high" | "urgent"tagsarray<string>messagestringrequiredDetailed problem description.
Response
Ticket created
idstringcustomer_idstringsubjectstringprioritystringstatus"open" | "pending" | "resolved""open" | "pending" | "resolved"tagsarray<string>messagestringcreated_atstring<date-time>updated_atstring<date-time>Cette page présente un endpoint généré en direct à partir d'une spec 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 générés automatiquement depuis la spec — aucune rédaction manuelle nécessaire.
Cet exemple utilise l'API Acme Support. Modifiez api.openapi dans votre docs.json pour pointer vers votre propre fichier de spec et générer de vrais endpoints.
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 :
- Badge d'endpoint — méthode et chemin avec code couleur
- Documentation des paramètres — paramètres de chemin, de requête, d'en-tête et de corps
- Schémas de requête/réponse — y compris les objets et tableaux imbriqués
- Exemples de code — cURL, Python, JavaScript, Go, Ruby, C#, Java, Rust, PHP (configurable via
api.examples.languages) - Détails d'authentification — extraits des security schemes de la spec
Toutes les références $ref de votre spec sont résolues automatiquement, 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.