如何在 azure 函數（2.0）的 swagger UI 中默認顯示帖子正文示例

Question

我是 swagger 打開 API 文檔的新手。 在azure function 應用程序 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 默認顯示上述 Expected 示例值。 這對我們也很有幫助。

請幫我解決這個問題，因為我們時間不多了。
提前致謝！

Answer 1

你應該使用， Pet是一個 model。

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

重現您的問題：

解決方案：

參考

1. 源碼： AzureFunctions.Extensions

2. 博客： 在 Azure 功能上介紹 Swagger UI

3. 設置啟動項目。