OpenAPI 模式名称中可以包含"/"吗？

Question

我正在使用一个使用"foo/bar"等字符串来识别(区分(JSON对象的API。

像$ref: '#/components/schemas/foo/bar'这样的$ref会给我带来错误。

是否支持此命名？我想利用 API 提供的这些属性来选择最合适的组件架构。

我正在使用OpenAPI 3.0.1。

Answer 1

No.

OpenAPI 3.0 组件名称(包括架构名称(只能包含以下字符：

a-z A-Z 0-9 - . _

(来源(

但是，架构中的属性名称没有限制，因此可以在属性名称中使用/：

components:
  schemas:
    MySchema:
      type: object
      properties:
        foo/bar:   # <-----
          type: string