rest - 枚举输入参数的Golang Swagger注释

Question

我不确定如何为休息调用的输入字符串参数指定注释。其中输入参数可以采用三个可能的字符串值之一。

如果我不得不假设会有一个包含这三个值（容器/捆绑包/网络）的下拉菜单，用户将选择其中一个。以前我指的是这个文档 来为 in 参数创建注释。

我正在尝试注释 go 代码，以便我可以swagger.yaml 自动生成 ( swagger generate spec -o ./swagger.yaml --scan-models)。不幸的是，我找不到需要枚举或输入参数仅限于某些值的带注释的示例。寻找一些代码示例。

Answer 1

像这样带有枚举注释的东西应该可以工作。

// swagger:parameters artifactInfo
type ArtifactTypeParam struct {
    // The type of artifact
    // in: path
    // enum: container,bundle,executbale
    // required: true
    ArtifactType string `json:"artifactType"`
}