Using swagger in. Net5

background ：Swagger There are many benefits , It can be used as a communication bridge between the front and back ends , It can also be used as the entry of debugging interface , Convenient and quick , Improve development efficiency , Below will be recorded in .NetCore Use in Swagger

1. quote Nuget package --Swashbuckle.AspNetCore.Swagger

2. stay Startup.cs in ConfigureServices Add Swagger service

services.AddSwaggerGen(s =>
                {
                    Dictionary<string, string> swaggerDic = new Dictionary<string, string>() {
            {"Common"," Common interface " },
            {"User"," User management interface " }
        };
                    foreach (KeyValuePair<string, string> kv in swaggerDic)
                    {
                        // The first parameter , Must be with  api  Of  GroupName  The values used are consistent .
                        s.SwaggerDoc(kv.Key, new OpenApiInfo()
                        {
                            Version = "v1",// The top right corner of the title shows 
                            Title = $"{kv.Value} API",
                            Description = $" {kv.Value} api  file "
                        });
                    }

                    s.IncludeXmlComments("WebApp.xml");

                    // Enable add token Verify input place 
                    s.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme
                    {
                        Description = "JWT to grant authorization ( Data will be transmitted in the request header )  Type... Directly in the box below {token}\"",
                        Name = "token",//jwt Default parameter name 
                        In = ParameterLocation.Header,//jwt Default storage Authorization Location of information ( Request header )
                        Type = SecuritySchemeType.ApiKey
                    });

                    s.AddSecurityRequirement(new OpenApiSecurityRequirement
                    {
                        {new OpenApiSecurityScheme
                        {
                            Reference=new OpenApiReference()
                            {
                                Id="Bearer",
                                Type=ReferenceType.SecurityScheme
                            }
                        },Array.Empty<string>() }
                    });
                });

The configuration enables token verification

3. stay Configure Add swagger The Conduit

 app.UseSwagger();
 app.UseSwaggerUI(s =>
 {
    Dictionary<string, string> swaggerDic = new Dictionary<string, string>() {
            {"Common"," Common interface " },
            {"User"," User management interface " }
        };
    // Configure the address of each controller 
    foreach (KeyValuePair<string, string> kv in CommonUtils.swaggerDic)
    {
      s.SwaggerEndpoint($"/swagger/{kv.Key}/swagger.json", kv.Value);// The first parameter must be the same as SwaggerDoc The parameters of the first method of the method are consistent ,  The last parameter is the filter condition 
     }
  });

​​​​​​​