在Swagger中定义具有混合数据类型的属性

Question

我已经有了一个工作中的swagger文档，它使用swagger UI项目生成文档，但我遇到了一个小问题。

Mongoose支持混合的数据类型，这基本上是一个可以包含任何内容的非结构化对象。但是，根据Swagger规范，属性的类型的唯一可能值是string、integer、number、boolean和数组。我在留档、Google或GitHub上Swagger-Spec项目的开放问题中找不到任何允许混合数据类型的内容。

在Swagger-Spec留档中，它们定义了type选项，它们引用了JSON-Schema项目。根据JSON-Schema规范，对象应该是一个选项，但它没有在Swagger-Spec中列为潜在值。

有人知道在Swagger文档中指示模型属性可以包含任何值（单个原始值或对象）的方法吗？

例子

猫鼬模式定义：

var sampleSchema = new mongoose.Schema({
    lookupCodes : { type: [mongoose.Schema.Types.Mixed] },
    address: { type: mongoose.Schema.Types.Mixed }
});

mongoose.model('Sample', sampleSchema);

猫鼬模型的使用：

var Sample = mongoose.model('Sample');
var doc = new Sample();

这些都是两个定义属性的有效值：

doc.lookupCodes = ['A', 'B', 3, 4, 5, 'F'];

doc.lookupCodes = ['A', { code: '123' }, 5];

doc.address = '123 Main St., San Jose, CA, 95125';

doc.address = { street: '123 Main St.', city: 'San Jose', state: 'CA', postalCode: '95125'}

Swagger 1.2文档（片段）：

"models": {
    "Sample": {
        "properties": {
            "lookupCodes": {
                "type": "array",
                "items": {
                    "type": "??????"
                },
                "description": "An array of lookup codes. Codes can be strings, numbers or an object containing the `code` property."
            },
            "address": {
                "type": "??????",
                "description": "An address. This value can be a single string, containing all the elements of the address together, or it can be a structured object with each of the elements as separate properties of the object."
            },

我只是想寻找一种方法，让查看文档的开发人员知道模型中的特定属性可以接受/返回任何值（原始变量或对象）。

Answer 1

在您的问题中，您描述了两个不同的用例。

第一个是使用具有混合值的数组，第二个是可以具有任何值的特定字段（无论是对象、基元还是潜在的数组）。

斯威格明确表示不支持这种建模。有几个原因，但他们集中在决定论和语言支持。虽然动态语言可以更容易地支持非确定性API，弱类型语言可以很容易地支持动态类型，但其他语言将因此受到影响。API旨在实现互操作性，与语言无关，因此您必须考虑这些限制。

虽然Swagger是一种文档工具，但它的工具生态系统包括了一些解决方案，这些解决方案需要能够以几乎任何语言生成和使用此类API。显然，它不能100%覆盖，但它试图避免已知问题。

Swagger 2.0在定义模型方面增加了更多的灵活性，甚至允许自由形式的对象（和do note-Object，而不是primitives）。虽然一般情况下不建议使用它，但有些用例是无法避免的，但即使是强类型语言也可以处理它（我可以详细介绍用例，但它与手头的问题无关）。

作为添加的信息-从文档的角度考虑，我将使用您的地址字段作为示例。你在这里说的是，在API方面，地址字段是一个通配符。你可以接受它的任何内容，它不必是地址，不必有结构，不必有特定的信息。如果有人愿意，他们可以使用该字段存储核发射代码。现在，如果这是您的意图，那么只需将字段标记为字符串值，如果有人想将序列化的JSON对象作为字符串发送，那么它也很合适。