如何在 azure 函数的 swagger UI 中默认显示帖子正文示例（2.0）

Question

我是大摇大摆的开放 API 文档的新手。在 azure function app 2.0 中集成 Aliencube.AzureFunctions.Extensions.OpenApi.Core。

代码如下：

    [FunctionName("TestFunction")]
    [OpenApiOperation(operationId: "TestFunction", tags: new[] { "TestFunction" })]
    [OpenApiRequestBody("text/plain", typeof(string))]
    public static async Task<IActionResult> TestFunctionRun([HttpTrigger(AuthorizationLevel.Anonymous,"post", Route = null)] HttpRequest TestFunctionRequest, ExecutionContext executionContext)
    {
        {
           //definition of function
        }
    }

在 Swagger 中显示如下

默认情况下，我们应该在示例值下方显示

{
  "username" : "testuser",
  "userid" : "1"
}

如果在 azurefunction 2.0 中使用 AzureFunctions.Extensions.Swashbuckle 默认显示上述预期示例值。这对我们也很有帮助。

请帮我解决这个问题，因为我们的时间不多了。
提前致谢！

Answer 1

你应该使用，Pet是一个模型。

[OpenApiRequestBody(contentType: "application/json", bodyType: typeof(Pet), Required = true, Description = "Pet object that needs to be added to the store")]

重现您的问题：

解决方案：

参考

1. 源码：AzureFunctions.Extensions

2. 博客：Introducing Swagger UI on Azure Functions

3. 设置启动项目。