使用可重用枚举时创建文档的问题

时间:2019-10-13 12:09:04

标签: enums yaml swagger swagger-3.0

使用可重用枚举时创建文档的问题 我的yaml文件看起来像这样

openapi: 3.0.2 components:   schemas:
    Countries:
      type: string
      enum:
        - Unknown
        - Afghanistan
        - Albania
        - Algeria
        - American Samoa
        - "\u00c5landIslands"
        - NotOtherwiseSpecified

,当我编译它时,它会正确创建java类,但是并没有创建文档,只是给了我:

国家- 并且没有显示该特定方案的更多信息。对于其他方案,将显示枚举选项,等等。 您能帮我解决这个问题吗?这是个大招还是我在某个地方弄错了。 swagger网站中的示例和我的代码遵循相同的规则:https://swagger.io/docs/specification/data-models/enums/。 我也在这里发布了类似的问题:https://community.smartbear.com/t5/SwaggerHub/Issue-with-creating-a-documentation-when-using-re-usable-enums/m-p/191938

P.S。我认为问题是由于特殊字符而来的,但事实并非如此。我尝试过没有该特定的枚举项,而且我也有另一种类似的可重用枚举,其行为方式相同。

1 个答案:

答案 0 :(得分:0)

这对我来说很好。我附上一个示例,以供参考。

route.yaml中的参数

      parameters:
        - name: Country
          in: query
          required: true
          schema:
            $ref: "#/components/schemas/test"

parameters.yaml中的声明

components:
  schemas:
    test:
      type: string
      enum:
        - Unknown
        - Afghanistan
        - Albania
        - Algeria
        - "\u00c5landIslands"

从Swagger UI附加图像 enter image description here

请添加更多详细信息以供参考,如上所述对我来说很好。