Set Bearer Token with nswag in ASP.NET Core 2.2

Question

I have an ASP.NET Core 2.2 Web Api and I added the swagger support with nswag. The web api is protected using a local IdentityServer4 that generates access tokens.

I found the code to add an authorization button and form and set the bearer token in the header. And it works!

public void ConfigureServices(IServiceCollection services)
{
//...   
            services.AddSwaggerDocument(config =>
            {
                config.DocumentName = "OpenAPI 2";
                config.OperationProcessors.Add(new OperationSecurityScopeProcessor("JWT Token"));
                config.AddSecurity("JWT Token", Enumerable.Empty<string>(),
                    new OpenApiSecurityScheme()
                    {
                        Type = OpenApiSecuritySchemeType.ApiKey,
                        Name = "Authorization",
                        In = OpenApiSecurityApiKeyLocation.Header,
                        Description = "Copy this into the value field: Bearer {token}"
                    }
                );
            });
//...
}

Button in the swagger page

Form for copy/paste of the bearer token

I'm looking for a way to automate the flow and setting the access token without a copy/paste.

Is it possible to setup nswag to do this?

score 8 · Accepted Answer · answered Nov 25 '19 at 03:15

You can enable authentication in generator and Swagger UI .To add OAuth2 authentication (OpenAPI 3) , in web api :

services.AddOpenApiDocument(document =>
    {
        document.AddSecurity("bearer", Enumerable.Empty<string>(), new OpenApiSecurityScheme
        {
            Type = OpenApiSecuritySchemeType.OAuth2,
            Description = "My Authentication",
            Flow = OpenApiOAuth2Flow.Implicit,
            Flows = new OpenApiOAuthFlows()
            {
                Implicit = new OpenApiOAuthFlow()
                {
                    Scopes = new Dictionary<string, string>
                    {
                        {"api1", "My API"}

                    },
                    TokenUrl = "http://localhost:5000/connect/token",
                    AuthorizationUrl = "http://localhost:5000/connect/authorize",

                },
            }
        });

        document.OperationProcessors.Add(
            new AspNetCoreOperationSecurityScopeProcessor("bearer"));
    }
);

Configure :

app.UseOpenApi();
app.UseSwaggerUi3(settings =>
{
    settings.OAuth2Client = new OAuth2ClientSettings
    {
        ClientId = "demo_api_swagger",

        AppName = "Demo API - Swagger",

    };
});

In identity server 4 , register the api :

public static IEnumerable<ApiResource> GetApis()
{
    return new List<ApiResource>
    {
        new ApiResource("api1", "My API")
    };
}

And the client :

new Client {
    ClientId = "demo_api_swagger",
    ClientName = "Swagger UI for demo_api",
    AllowedGrantTypes = GrantTypes.Implicit,
    AllowAccessTokensViaBrowser = true,
    RedirectUris = {"https://localhost:44304/swagger/oauth2-redirect.html"},
    AllowedScopes = { "api1" }
},

After clicking Authorize button in UI , you can authenticate with IDS4 and get api's access token , then token will automatically append to authorization request header when making api request .

Perfect! It works. For the next readers: "In my case I did a change in the client config adding a "RequireConsent = false," and of course che 44304 port to my value" — Tonyc, Nov 25 '19 at 07:23
I success with this solution in couple minutes with NSwag on DotNet Core 3.1 after failed on try the latest Swashbuckle.AspNetCore in couple hours. Thanks. — Jun, Mar 20 '20 at 03:01

Set Bearer Token with nswag in ASP.NET Core 2.2

1 Answers1