Swagger UI için OAuth Bearer Token

Herkese merhaba. Bu yazıda Swagger UI için OAuth Bearer Token kodu ile ilgili bilgi vereceğim.

ASP.Net Code projelerinizde yazdığınız API’leri test ederken ilgili Token bilgisini de kullanmak istiyorsanız aşağıdaki kodu kullanabilirsiniz.

Aşağıdaki kod ASP.Net Core 3.1 ve öncesi için işinize yarayacaktır. (Startup.cs)

services.AddSwaggerGen(opt =>
 {
     opt.SwaggerDoc("v1", new OpenApiInfo { Title = "MyAPI", Version = "v1" });
     opt.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme
     {
         In = ParameterLocation.Header,
         Description = "Please enter token",
         Name = "Authorization",
         Type = SecuritySchemeType.Http,
         BearerFormat = "JWT",
         Scheme = "bearer"
     });

     opt.AddSecurityRequirement(new OpenApiSecurityRequirement
     {
         {
             new OpenApiSecurityScheme
             {
                 Reference = new OpenApiReference
                 {
                     Type=ReferenceType.SecurityScheme,
                     Id="Bearer"
                 }
             },
             new string[]{}
         }
     });
 });

Aşağıdaki kod ASP.Net Core 5.0 ve sonrasıiçin işinize yarayacaktır. (Program.cs)

builder.Services.AddSwaggerGen(opt =>
{
    opt.SwaggerDoc("v1", new OpenApiInfo { Title = "MyAPI", Version = "v1" });
    opt.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme
    {
        In = ParameterLocation.Header,
        Description = "Please enter token",
        Name = "Authorization",
        Type = SecuritySchemeType.Http,
        BearerFormat = "JWT",
        Scheme = "bearer"
    });

    opt.AddSecurityRequirement(new OpenApiSecurityRequirement
    {
        {
            new OpenApiSecurityScheme
            {
                Reference = new OpenApiReference
                {
                    Type=ReferenceType.SecurityScheme,
                    Id="Bearer"
                }
            },
            new string[]{}
        }
    });
});

Yukarıdaki kodları programınızda ilgili yerlere ekleyip programı çalıştırınca aşağıdaki gibi yetkilendir simgesi göreceksiniz.

Butona tıklayınca aşağıdaki ekranı göreceksiniz.

Postman ile elde ettiğininiz token değerini burada kullanabilirsiniz.

Herkese çalışma hayatında ve yaşamında başarılar kolaylıklar.