使用规范编辑器创建规范

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档。
信息

使用规范编辑器创建和验证 OpenAPI 规范,而无需编写任何代码。

访问规范编辑器

在规范编辑器中打开 OpenAPI 规范,如以下部分中所述:

下图显示了在规范编辑器中打开的 Petstore API 的规范:

如上图所示,您可以通过规范编辑器执行以下操作:

  • 在左侧窗格中,使用 JSON 或 YAML 格式创建 OpenAPI 规范来对 API 进行建模。
  • 在右侧窗格中查看自动生成的 API 文档。
  • 在您输入时,根据 OpenAPI 规范标准验证您的规范。
  • 保存 OpenAPI 规范,或关闭规范并取消修改。

帮我处理 JSON 和 YAML

JSON(JavaScript 对象表示法)是一种轻量级数据交换格式,用于表示简单的数据结构和关联数组。如需了解详情,请访问 https://www.json.org。

YAML(YAML 不是标记语言)是一种数据序列化/表示标准,提供了一种可映射到数据结构(例如列表、关联数组和标量)的语法。如需了解详情,请访问 https://yaml.org。

JSON 和 YAML 都是机器可读的,但也便于人类阅读和理解。下图比较了同一 OpenAPI 规范中分别使用 JSON 和 YAML 编写的两段简短摘录:

JSON 与 YAML

验证规范

规范编辑器会根据 OpenAPI 规范标准验证您的 OpenAPI 规范。在您输入内容时,如果 OpenAPI 规范中存在错误,规范编辑器会在右侧窗格顶部显示“错误”对话框,并提供有关错误及其关联的行号的更多信息,以便您轻松更正这些错误。

错误

保存规范

如需保存 OpenAPI 规范,请点击顶部导航栏中的保存。

如果您是首次保存规范,系统会提示您输入文件名。如果您未指定文件名,则默认为“未命名”。您可以稍后重命名。

关闭规范

如需关闭 OpenAPI 规范而不保存所做的修改,请点击顶部导航栏中的取消。系统会返回到规范列表。