azure-functions-openapi-extension icon indicating copy to clipboard operation
azure-functions-openapi-extension copied to clipboard

Microsoft.Azure.WebJobs.Extensions.OpenApi: OpenApiSecurityAttribute not generating bearer authentication in swagger.json

Open snerte opened this issue 3 years ago • 1 comments

Describe the issue I am using Microsoft.Azure.WebJobs.Extensions.OpenApi in my azure function to generate my OpenAPI spec. Unfortunately generating bearer token authentication in the swagger.json fails.

Azure function info:

  <PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <AzureFunctionsVersion>v4</AzureFunctionsVersion>
  </PropertyGroup>

<ItemGroup>
	<PackageReference Include="Microsoft.Azure.WebJobs.Extensions.OpenApi" Version="1.3.0" />
  </ItemGroup>

To Reproduce Steps to reproduce the behavior:

  1. Add the OpenApiSecurityAttribute to the function
        [OpenApiSecurity("bearer_auth", SecuritySchemeType.Http, Scheme = OpenApiSecuritySchemeType.Bearer, BearerFormat = "JWT")]
  1. Start the function
  2. Open the swagger ui
  3. Click authenticate

Expected behavior Authentication works in swagger ui, swagger.json securityDefinitions/bearer_auth is generated.

Actual behavior

Error is shown: image

On investigation the swagger.json securityDefinitions/bearer_auth is empty:

{
  "securityDefinitions": {
    "bearer_auth": {}
  }
}

snerte avatar May 24 '22 09:05 snerte

I have the same problem

zerosnp avatar Aug 11 '22 16:08 zerosnp

Try to set settings for your IOpenApiConfigurationOptions OpenApiVersion = OpenApiVersionType.V3

power911 avatar Sep 26 '22 07:09 power911