跳转到主要内容
Mintlify 中的每个 MDX 端点页面只记录一个端点。openapi、api 和 asyncapi frontmatter 字段都必须是单一字符串。如果任何页面将这些字段之一设置为列表、数字或其他非字符串值,Mintlify 会使部署失败,并显示以下消息:
Mintlify 不会发布失败部署中的任何更改。在您修复该页面之前,您的线上站点会继续提供上一次成功的部署。 针对单个页面的错误以 Invalid "<field>" frontmatter at path 开头。它会列出页面路径以及 Mintlify 收到的值类型,例如 received an array。

常见原因

  • 在一个字段中列出多个端点,例如 openapi: [GET /users, POST /users]。
  • 将值写成 YAML 列表,分布在以 - 开头的多行中。
  • 使用了被 YAML 解析为数字或布尔值而非字符串的值。

修复 frontmatter

将该字段设置为单个端点字符串。用引号包裹该值,以确保 YAML 始终将其解析为字符串。
Incorrect
Correct
如需记录多个端点,请为每个端点创建单独的页面。您也可以让 Mintlify 根据您的规范为每个操作生成一个页面。请参阅自动填充 API 页面。 如需了解 openapi frontmatter 的完整格式,请参阅编写端点文档。