OpenApi 3.0：对现有类的引用

Question

我想使用库中的类作为属性的类型。说是吧foo.lib.Foo。将其正确定义为属性类型的正确方法是什么？

SomeDto:
  type: object
  properties:
     foo:
        $ref: `foo.lib.Foo`??? 

Answer 1

这可以通过定义类型映射并显式引用该类型来完成。

1. 在插件配置中定义类型映射

    <configuration>
         ...
         <importMappings>
             <importMapping>Foo=foo.lib.Foo</importMapping>
         </importMappings>
         ...
    </configuration>

2. 参考类型：

SomeDto:
  type: object
  properties:
     foo:
        $ref: '#/components/schema/Foo' 

3. 将库的依赖项包含在类路径（该dependencies部分）中。

更新如果它仍然不起作用，请尝试按如下方式引用您的课程：

SomeDto:
  type: object
  properties:
     foo:
        $ref: 'Foo'