go-swagger:没有可用于解组的规范

Question

我正在尝试为用Golang编写的REST端点定义一个swagger操作。我需要指定POST请求主体和响应。

// swagger:operation POST /user user createUser
//
// Creates user
//
// produces:
// - application/json
// parameters:
// - name: requestBody
//   in: body
//   description: user details
//   required: true
//   schema:
//     "$ref": "#/definitions/User"
// responses:
//  200: CommonResponse
//  400: CommonResponse
//  500: CommonResponse

// CreateUser will create user
func (h *UserHandler) CreateUser(c *gin.Context) {

但我在尝试生成相同的规范时遇到错误

cd cmd/server && GO111MODULE=on swagger generate spec -o ../../api/swagger.json -m
operation (createUser): no spec available to unmarshal
Makefile:5: recipe for target 'generate-swagger' failed
make: *** [generate-swagger] Error 1

请帮我拿一下这些。这里指定的规格是什么。提前致谢

Answer 1

我认为您遗漏了一组必须放在yaml部分之前的破折号---。

(参见本页示例上方的行：https://goswagger.io/use/spec/operation.html)

这条更新后的评论应该对你有效：

// swagger:operation POST /user user createUser
//
// Creates user
//
// ---
// produces:
// - application/json
// parameters:
// - name: requestBody
//   in: body
//   description: user details
//   required: true
//   schema:
//     "$ref": "#/definitions/User"
// responses:
//  200: CommonResponse
//  400: CommonResponse
//  500: CommonResponse