如何为动态请求/响应创建 swagger 文档

Question

我们有一个基于 SQL 定义的元数据动态驱动的 API 应用程序。此 API 应用程序是一个报告应用程序，报告由传递到 API 的请求类型驱动。这意味着如果 JSON 请求像这样传递 - 前1

 {
    "Field1": "Value1"
    "GroupBy": ["GroupByValue1", "GroupByValue2"]
    }

然后给出以下结果集 -

{
"GroupByValue1": "SomeValue1"
"GroupByValue2": "SomeValue2"
... other fields based on GroupBy1 and GroupBy2
}

前2

{
"Field1": "Value1"
"GroupBy": ["GroupByValue3"]
}

然后给出以下结果集 -

{
"GroupByValue3": "SomeValue1"
... other fields based on GroupBy3
}

因此，该请求的请求与字段的映射是在 SQL 数据库中定义的。 我们需要为这种动态请求生成 swagger 文档。所以我的问题是，由于我们使用 swashbuckle 进行 swagger 文档，因此我们必须根据传递的请求为其提供特定的结果集。现在我们有 API 来为我们提供这些请求/结果集关系，但是有没有一种方法可以基于此 API（使用 C# 代码或打字稿）完全动态地生成文档，从而为我们提供请求/结果集关系。

Answer 1

您可以使用

IDocumentFilter

创建动态 Swagger 文档。 我们还在这个示例中使用动态 SQL 元数据。