如何为go-swagger中的自定义引用数组模型添加示例？

方法1：在自定义数组类型上添加示例注释 #

go-swagger对引用模型会读取模型本身的注释，而非结构体字段的注释。直接把示例注释加在MyArray类型定义上即可：

// example: ["This", "Is", "A", "Test"]
type MyArray []string

type MyResponse struct {
    MyTestArray MyArray `json:"MyTestArray"`
}

生成的swagger规范中，MyArray模型会携带该示例，结构体引用时就能正常显示。

方法2：用swagger:model注释明确标记模型 #

如果需要更精准的模型控制，给自定义类型加上swagger:model注释，同时补充示例：

// swagger:model
// example: ["This", "Is", "A", "Test"]
type MyArray []string

type MyResponse struct {
    MyTestArray MyArray `json:"MyTestArray"`
}

这种方式明确告知go-swagger将该类型作为swagger模型处理，示例会被正确解析。

方法3：在结构体字段上使用swagger:example标签 #

若不想修改自定义类型的注释，可在结构体字段上通过swagger:example标签指定示例：

type MyArray []string

type MyResponse struct {
    // swagger:example ["This", "Is", "A", "Test"]
    MyTestArray MyArray `json:"MyTestArray"`
}

注意部分版本的go-swagger对数组示例的格式要求严格，优先推荐前两种方法。

内容的提问来源于stack exchange，提问作者user1722361