如何在Swagger UI的multipart / form-data中的json参数中显示架构?

时间:2019-09-25 11:43:27

标签: asp.net-core swagger swagger-ui swashbuckle

我正在使用OpenApi 3.0和Swagger UI。

(重要的是Swashbuckle和ASP.Net Core)

我有multipart/form-data,其中有2个参数:

    JSON中的
  • ProductToAdd对象描述
  • Image作为文件。

我定义了模式和示例。

现在我设法做到了 My result

我的目标是这样的:

Target result

我的问题是如何呈现第二张图中的架构和示例? 我在swagger.json中没有发现任何帮助。

Ps。如果您有好奇心,可以完美地执行工作。

@edit

我为此做了nuget包。您可以找到它here

1 个答案:

答案 0 :(得分:1)

当前(截至2019年9月),Swagger UI不在multipart/*请求中显示对象类型字段的架构,它仅显示这些字段的示例值。这是相应的功能请求:

Display static documentation information for multipart properties in OpenAPI 3.0 files