英文:
Swagger params names form data
问题
我正在尝试为我的API（使用golang编写）创建文档。
// swagger:parameters getTax
type TaxQS struct {
// Required: true
TaxCode string `form:"tax_code" binding:"required"`
// 出生地
Place string `form:"model"`
// 年份
Year int `form:"year"`
// 月份
Month int `form:"month"`
}
对于请求，我使用查询参数，并且Swagger工作正常，我已经为我的API编写了文档，但唯一的问题是参数名称不同。例如，我期望的参数名是tax_code，但实际上是TaxCode。我尝试添加// in: query，但仍然存在这个问题。
英文:
I am trying to create documentation for my API (golang)
// swagger:parameters getTax
type TaxQS struct {
// Required: true
TaxCode string `form:"tax_code" binding:"required"`
// birth place
Place string `form:"model"`
// year
Year int `form:"year"`
// month
Month int `form:"month"`
for requests I use query params and swagger works fine I have the doc for my API but the only problem is param names are different for example I was expected param name is tax_code but I have TaxCode also I try to add // in: query still I have this problem
答案1
得分: 1
尝试在结构体中添加json标签后生成Swagger文档
// swagger:parameters getTax
type TaxQS struct {
// Required: true
TaxCode string `json:"tax_code" form:"tax_code" binding:"required"`
// 出生地
Place string `json:"model" form:"model"`
// 年份
Year int `json:"year" form:"year"`
// 月份
Month int `json:"month" form:"month"`
}
英文:
Try generating swagger doc after adding json tag in your struct
// swagger:parameters getTax
type TaxQS struct {
// Required: true
TaxCode string `json:"tax_code" form:"tax_code" binding:"required"`
// birth place
Place string `json:"model" form:"model"`
// year
Year int `json:"year" form:"year"`
// month
Month int `json:"month" form:"month"`
}
通过集体智慧和协作来改善编程学习和解决问题的方式。致力于成为全球开发者共同参与的知识库，让每个人都能够通过互相帮助和分享经验来进步。
评论