登录
首页 >  Golang >  Go问答

使用 Golang Swagger 注释列举输入参数

来源:stackoverflow

时间:2024-03-28 10:18:23 163浏览 收藏

积累知识,胜过积蓄金银!毕竟在Golang开发的过程中,会遇到各种各样的问题,往往都是一些细节知识点还没有掌握好而导致的,因此基础知识点的积累是很重要的。下面本文《使用 Golang Swagger 注释列举输入参数》,就带大家讲解一下知识点,若是你对本文感兴趣,或者是想搞懂其中某个知识点,就请你继续往下看吧~

问题内容

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

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

我正在尝试注释go代码,以便我可以自动生成swagger.yaml swagger生成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"`
}

理论要掌握,实操不能落!以上关于《使用 Golang Swagger 注释列举输入参数》的详细介绍,大家都掌握了吧!如果想要继续提升自己的能力,那么就来关注golang学习网公众号吧!

声明:本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>