枚举输入参数的Golang Swagger注释



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

如果我必须假设会有一个包含这三个值(容器/捆绑包/网络(的下拉菜单,用户会选择其中一个。以前,我参考此文档为in参数创建注释。

我正在尝试对go代码进行注释,这样我就可以自动生成swagger.yaml(swagger generate spec -o ./swagger.yaml --scan-models(。不幸的是,我找不到一个需要枚举的注释示例,或者输入参数仅限于某些值。查找一些代码示例。

类似的枚举注释应该可以工作。

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

相关内容

  • 没有找到相关文章

最新更新