Question

我正在使用一个使用“ foo / bar”之类的字符串来标识（区分）JSON对象的API。

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

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

我正在使用OpenAPI 3.0.1。

Answer 1

否。

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

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

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

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