.net swagger 怎么加鉴权
时间: 2024-05-11 22:10:28 浏览: 214
Asp.Net WebApi添加SwaggerUI
4星 · 用户满意度95%
在.NET中使用Swagger进行鉴权可以通过以下步骤实现:
1. 首先,确保你的项目中已经安装了`Swashbuckle.AspNetCore`包。如果没有安装,可以通过以下命令进行安装:
```shell
dotnet add package Swashbuckle.AspNetCore
```
2. 在`Startup.cs`文件中的`ConfigureServices`方法中,添加Swagger的服务配置:
```csharp
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "Your API", Version = "v1" });
// 添加鉴权信息
var securityScheme = new OpenApiSecurityScheme
{
Name = "Authorization",
Type = SecuritySchemeType.ApiKey,
Scheme = "Bearer",
BearerFormat = "JWT",
In = ParameterLocation.Header,
Description = "Enter your JWT token in the text input below.",
};
c.AddSecurityDefinition("Bearer", securityScheme);
// 添加鉴权要求
var securityRequirement = new OpenApiSecurityRequirement
{
{
new OpenApiSecurityScheme
{
Reference = new OpenApiReference
{
Type = ReferenceType.SecurityScheme,
Id = "Bearer"
}
},
new string[] {}
}
};
c.AddSecurityRequirement(securityRequirement);
});
```
3. 在`Startup.cs`文件中的`Configure`方法中,启用Swagger中间件:
```csharp
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "Your API V1");
// 添加鉴权按钮
c.DocumentTitle = "Your API";
c.InjectStylesheet("/swagger-ui/custom.css");
c.InjectJavascript("/swagger-ui/custom.js");
});
```
4. 在你的控制器或操作方法上添加`[Authorize]`特性,以启用鉴权。
现在,你的API将会在Swagger UI中显示鉴权按钮,并要求用户提供JWT令牌进行访问。
阅读全文