主页 / 问题 / 1246311
Accepted
Ainar-G
Asked:2022-02-20 02:29:51 +0800 CST2022-02-20 02:29:51 +0800 CST

OpenAPI 3.0 中的 XML 文档类型？

  • 772

问题相对简单：是否可以在我的OpenAPI 3.0规范中的模式对象中描述 传出XML文档的文档 类型？我看到有一些 XML Object，但它仅用于属性，并且没有关于doctype的词。Representing XML文章中也没有提到它。只是不支持吗？

xml

1 个回答

  1. Best Answer

    OpenAPI 没有 DOCTYPE 的内置属性，但有一个扩展机制- 以 . 为前缀的任意属性x-。因此，您可以将 DOCTYPE 指定为扩展，如下所示：

    Customer:
  type: object
  properties:
    ...

  x-doctype: <!DOCTYPE customer SYSTEM "https://mycompany.com/dtd/customer.dtd">

  # или значение без обертки <!DOCTYPE ... >
  # x-doctype: customer SYSTEM "https://mycompany.com/dtd/customer.dtd"

  # или добавить расширение внутрь атрибута `xml`
  # xml:
  #  x-doctype: <!DOCTYPE customer SYSTEM "https://mycompany.com/dtd/customer.dtd">

    之类的。

    请记住，扩展只是元数据和工具（代码生成器、验证器等）不处理他们不知道的扩展。因此，如果您需要以某种方式处理此扩展，则必须自己实现其处理。

    • 1

相关问题