使用官方Swagger API架构验证Swagger API声明

Question

swagger规范存储库提供了描述有效Swagger 2.0 API定义的JSON模式。我想使用此模式来验证给定API定义文件是否有效，然后再尝试解释它。我使用以下代码使用Json.NET加载模式：

JsonSchema swaggerApiSchema;
using (var textReader = new JsonTextReader(new StreamReader(@"C:\path\to\schema.json")))
{
    swaggerApiSchema = JsonSchema.Read(textReader);
}

这将抛出一个 ArgumentException，报告“无法将数组转换为布尔值”。

模式文件有问题吗？这是Json的错误吗。NET，还是我只是做错了什么？

Answer 1

根据文档，JSON.NET 实现了 JSON 架构草案 3。更多 这里.但是，您发布的 Swagger 架构是根据 JSON 架构草稿 4 创建的。JSON 架构的草稿 3 和草稿 4 之间的区别之一是必需属性，在 JSON 架构草稿 3 中，该属性是属性中子架构的属性。在 JSON 架构草稿 4 中，第一级关键字扮演相同的角色，并且有一个字符串数组作为参数。

JSON 架构草稿 3 的示例：

{
    "properties": {
        "Id": {
            "required": true,
            "type": "integer"
        },
        "FirstName": {
            "required": true,
            "type": "string",
        },
        "LastName": {
            "required": true,
            "type": "string
        }
    }
}

JSON模式草案4的示例:

{
    "properties": {
        "Id": {
            "type": "integer"
        },
        "FirstName": {
            "type": "string"
        },
        "LastName": {
            "type": "string"
        }
    },
    "required": [ "Id", "FirstName", "LastName" ]
}

请注意这两种模式的区别，即如何定义所需的属性。这就是为什么您会收到一个错误：“无法将数组转换为布尔值”。

这是Swagger JSON模式中所需属性的第一次出现，这导致了错误：

"required": [ "swagger", "info", "paths" ]

我建议用实现JSON模式草案4的解析器进行验证。