枚举输入参数的 Golang Swagger 注释

Question

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

如果我不得不假设会有一个包含这三个值 (containers/bundles/web) 的下拉菜单，并且用户会选择其中一个。以前我指的是 documentation 为 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"`
}

枚举输入参数的 Golang Swagger 注释

Golang Swagger annotation for enum input parameter

rest

go

swagger

go-swagger