OpenAPI 示例
查看实时的 OpenAPI 生成端点页面，了解 Jamdesk 如何直接根据规范呈现请求、响应和身份验证。
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>此页面展示了一个由 OpenAPI 规范生成的实时端点。右侧面板中的请求架构、响应模型和代码示例均根据规范自动生成，无需手动编写。
此示例使用 Acme Support API。更新 docs.json 中的 api.openapi，指向你自己的规范文件，即可生成真实端点。
多语言文档？ 在源规范文件旁放置一个 <spec>.<lang>.<ext> 文件（例如 example-api.fr.yaml），用户通过 /fr/... 查看页面时，Jamdesk 会呈现翻译后的版本。请参阅翻译 OpenAPI 规范。
此页面已启用 API Playground。点击上方端点中的 Try it，即可在线测试 API。
生成的内容
只需一行 openapi frontmatter，Jamdesk 就会自动生成：
- 显示方法和路径并进行颜色编码的端点标记
- 路径、查询、标头和正文参数的参数文档
- 请求和响应架构，包括嵌套对象和数组
- cURL、Python、JavaScript、Go、Ruby、C#、Java、Rust 和 PHP 的代码示例（可通过
api.examples.languages配置） - 从规范的安全方案中提取的身份验证详细信息
规范中的所有 $ref 引用都会自动解析，因此你可以像往常一样使用 components/schemas 组织架构。
设置 OpenAPI
将 OpenAPI 3.x 规范（YAML 或 JSON）放入 openapi/ 目录，在 docs.json 的 api.openapi 下注册该规范，然后将 openapi: /openapi/your-spec.yaml METHOD /path 添加到任意页面的 frontmatter 中。详细信息请参阅 OpenAPI 设置指南。
使用 YAML 编写规范？通过免费的 YAML Validator 检查规范，在构建解析前发现缩进和语法错误。