带有空格的swagger codegen和$ref属性

Question

我目前正在考虑使用我们的swagger文件，该文件主要用于生成客户端SDK的文档。

我注意到我们的 swagger 文件（采用 swagger 2.0 json 格式）包含对以下防御的引用：

"$ref":"#/definitions/My%20Awesome%20Object"

当我生成 C# SDK 时，这将转换为如下所示的代码：

ApiResponse<My20Awesome20Object>

从swagger文件中删除解决了这个问题，但与web后端人员交谈时，他们说它在那里，否则无法验证，我找不到引用，但我记得我在swagger代码页中找到了一个引用，该引用声明$ref字段应该是URI编码的，因此看起来是正确的。

我目前的计划是编写一个简单的脚本，只需剥离，以生成对类的正确引用。但这感觉像是一个丑陋的变通方法。您有什么建议吗？如何在获得正确代码的同时，以符合标准的更好方式解决这个问题？

干杯，马库斯

Answer 1

$ref值是URI。存在是因为定义部分中的架构名称包含空格，如下所示：

"definitions": {
  "My Awesome Object": {    // <---   $ref: "#/definitions/My%20Awesome%20Object"
    "type": "object",
    ...
  }
}

一些工具在处理模式名称中的非字母数字字符方面存在问题；这包括空格，

最好的解决方法是从$affs中删除，并从定义部分中的模式名称中删除空格。这样，如果您迁移到较新的OpenAPI版本，模式名称将与OpenAPI 3.0向前兼容。