.net core Swagger添加bearer token參數


引入swagger后,在services.AddSwaggerGen中增加如下內容

            // Register the Swagger generator, defining 1 or more Swagger documents
            services.AddSwaggerGen(c =>
            {
                ......

                //Bearer 的scheme定義
                var securityScheme = new OpenApiSecurityScheme()
                {
                    Description = "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"",
                    Name = "Authorization",
                    //參數添加在頭部
                    In = ParameterLocation.Header,
                    //使用Authorize頭部
                    Type = SecuritySchemeType.Http,
                    //內容為以 bearer開頭
                    Scheme = "bearer",
                    BearerFormat = "JWT"
                };

                //把所有方法配置為增加bearer頭部信息
                var securityRequirement = new OpenApiSecurityRequirement
                    {
                        {
                                new OpenApiSecurityScheme
                                {
                                    Reference = new OpenApiReference
                                    {
                                        Type = ReferenceType.SecurityScheme,
                                        Id = "bearerAuth"
                                    }
                                },
                                new string[] {}
                        }
                    };

                //注冊到swagger中
                c.AddSecurityDefinition("bearerAuth", securityScheme);
                c.AddSecurityRequirement(securityRequirement);
            });

添加成功后,swagger右上方會有一個Authroize按鈕,點擊后可以輸入bearer token。

每個API方法后,會有一個鎖的標志,表明該方法會傳遞bearer token。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM