go-restful-openapi $refs必须引用文档中的有效位置

Question

我使用go-restful和go-restful-openapi相结合来自动生成我的swagger文档。但是，在使用swagger编辑器测试该工具时，我得到以下错误：

$refs必须引用文档中的有效位置。

结构

type Users struct {
  # uuid imported from github.com/google/uuid@v1.2.0
  RelatedUsers []uuid.UUID `json:"relatedIds" validate:"required"`
}

生成的虚张声势片段

  "Users": {
   "required": [
    "relatedIds"
   ],
   "properties": {
    "relatedIds": {
     "type": "array",
      "$ref": "#/definitions/uuid.UUID" #this line returns an error 
     }
    }
   }
  }

下面是swagger配置：

    swaggerConfig := restfulspec.Config{
        WebServices: restfulContainer.RegisteredWebServices(),
        APIPath:     "/swagger.json",
        PostBuildSwaggerObjectHandler: func(swo *spec.Swagger) {
            swo.Info = &spec.Info{
                InfoProps: spec.InfoProps{
                    Title:       "User Service",
                    Description: "An example service for stackoverflow",
                    Version:     "1.0.0",
                },
            }
        },
    }

注意:如果我像下面这样替换了swagger编辑器中的行，那么错误就消失了，但是，我想不出如何自动配置swagger。

  "Users": {
   "required": [
    "relatedIds"
   ],
   "properties": {
    "relatedUsers": {
        type: array
        items:
         type: "string"
         format: "uuid"
     }
    }
   }
  }

Answer 1

万一有人遇到这个问题：go-restful-openapi无法解决导入的自定义类型。若要解决此问题，请将类型添加到定义中

swo.Definitions["uuid.UUID"] = spec.Schema{
    SchemaProps: spec.SchemaProps{
                Type:   []string{"string"},
                Format: "uuid",
    },
}