OpenAPI Example
See a live OpenAPI-generated endpoint page and learn how Jamdesk renders requests, responses, and authentication directly from your 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>This page demonstrates a live endpoint generated from an OpenAPI specification. The request schema, response models, and code examples in the right panel are all auto-generated from the spec, with no manual authoring required.
This example uses the Acme Support API. Update api.openapi in your docs.json to point at your own spec file to generate real endpoints.
Multi-language docs? Provide a <spec>.<lang>.<ext> file next to your source spec (e.g., example-api.fr.yaml) and Jamdesk renders the translated version when users view the page under /fr/.... See Translating OpenAPI Specs.
This page has the API Playground enabled. Click Try it on the endpoint above to test the API live.
What Gets Generated
From a single openapi frontmatter line, Jamdesk auto-generates:
- An endpoint badge showing the method and path with color coding
- Parameter documentation for path, query, header, and body parameters
- Request and response schemas, including nested objects and arrays
- Code examples in cURL, Python, JavaScript, Go, Ruby, C#, Java, Rust, and PHP (configurable via
api.examples.languages) - Authentication details pulled from the spec's security schemes
All $ref references in your spec are automatically resolved, so you can organize schemas with components/schemas as usual.
Setting Up OpenAPI
Place your OpenAPI 3.x spec (YAML or JSON) in the openapi/ directory, register it in docs.json under api.openapi, then add openapi: /openapi/your-spec.yaml METHOD /path to any page's frontmatter. See the OpenAPI setup guide for full details.