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

Question

I'm new to swagger open API documentation. Integrating the Aliencube.AzureFunctions.Extensions.OpenApi.Core in azure function app 2.0 .

Here is the code:

    [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
        }
    }

In Swagger it is displaying as below

we are expected to display below example value by default

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

If the above Expected example value is displayed by default by using AzureFunctions.Extensions.Swashbuckle in azurefunction 2.0. It is also help full for us.

Please help me out from this problem as we are running out of time.
Thanks in advance!

Answer 1

You should use， Pet is a model.

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

Reproduce your problem:

Solution:

Reference

1. Source code ： AzureFunctions.Extensions

2. Blog : Introducing Swagger UI on Azure Functions

3. set startup project.