Haskell servant: 分块上传的 Swagger 描述

Question

我正在使用 servant-swagger 来定义 REST 服务并从中生成 Swagger 文件。它使用 File upload combinator 的扩展版本来为端点定义客户端以添加文件。我想在上传 API 中添加 Swagger 描述。如果我可以添加一个像

这样的参数，我会很高兴

{
  "in": "formData",
  "name": "file",
  "type": "file",
  "description": "File to upload"
}

大摇大摆。知道怎么做吗？我在尝试

instance HasSwagger api => HasSwagger (Files b :> api) where
  toSwagger _ = toSwagger (Proxy :: Proxy api)
    & allOperations.description .~ Just (Text.pack "Files description")

但这不会在 Swagger 文件中生成描述（尽管它可以编译）。

Answer 1

用这个：

instance HasSwagger api =>
         HasSwagger (Files b :> api) where
  toSwagger _ = toSwagger (Proxy :: Proxy api)
    & addParam param
    where
      param = mempty
        & name .~ "file"
        & required ?~ True
        & description ?~ "File to upload"
        & schema .~ ParamOther (mempty
            & in_ .~ ParamFormData
            & paramSchema .~ (mempty & type_ .~ SwaggerFile))

Haskell servant: 分块上传的 Swagger 描述

Haskell servant: Swagger description for MultiPart upload

haskell

swagger

servant