你会.Net之Swagger基础使用吗?-.net swagger

[[399419]]

本文转载自微信公众号「鹏祥」，作者AZRNG。转载本文请联系鹏祥公众号。

介绍

Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。日常可以用于后端开发人员测试接口或者前后端联调使用。从.net5开始，swagger已经集成到vs2019编译器中，可以通过勾对选项“启用OpenAPI支持”显示基本的swagger配置。

本文示例环境：vs2019、net5

1 基本使用

新建一个NetCore API项目，为了测试效果，我多创建几个控制器

image.png

1.1 安装组件

<ItemGroup> 
   <PackageReference Include="Swashbuckle.AspNetCore" Version="5.6.3" /> 
 </ItemGroup>

1.2 注册swagger服务

在ConfigureServices中

public void ConfigureServices(IServiceCollection services) 
{ 
    services.AddControllers(); 
    services.AddSwaggerGen(c => 
    { 
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "WebApi", Version = "v1" }); 
    }); 
}

注意：

//netcore3.0之前版本用法

c.SwaggerDoc("v1", new Info { Title = "WebApi", Version = "v1" });

1.3 使用Swagger

public void Configure(IApplicationBuilder app, IWebHostEnvironment env) 
{ 
    if (env.IsDevelopment()) 
    { 
        app.UseDeveloperExceptionPage(); 
        app.UseSwagger(); 
        app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "WebApi v1")); 
    } 
 
    app.UseRouting(); 
 
    app.UseAuthorization(); 
 
    app.UseEndpoints(endpoints => 
    { 
        endpoints.MapControllers(); 
    }); 
}

该示例代码配置的swagger只在Development环境下显示，可以根据实际情况来修改

1.4 启动

运行项目，展示下面的效果

image.png

如果这是你写的接口，这个时候你的其他同事去看，真的会一脸懵逼，你这写的都是啥玩意，那么我们来给这加上注释吧。

/// <summary> 
/// 用户控制器 
/// </summary> 
[Route("api/[controller]")] 
[ApiController] 
public class UserController : ControllerBase 
{ 
    /// <summary> 
    ///查询用户列表 
    /// </summary> 
    /// <returns></returns> 
    [HttpGet] 
    public IEnumerable<string> Get() 
    { 
        return new string[] { "value1", "value2" }; 
    } 
 
    /// <summary> 
    /// 查询用户详情 
    /// </summary> 
    /// <param name="id"></param> 
    /// <returns></returns> 
    [HttpGet("{id}")] 
    public string Get(int id) 
    { 
        return "value"; 
    } 
 
    /// <summary> 
    /// 删除用户 
    /// </summary> 
    /// <param name="id"></param> 
    [HttpDelete("{id}")] 
    public void Delete(int id) 
    { 
    } 
}

这样子加了注释还不行，swagger还读取不到我们的注释，我们还需要生成xml文档并且让swagger使用，选中项目右键属性=>生成=>xml文档文件

image.png

修改注入swagger配置

services.AddSwaggerGen(c => 
   { 
       c.SwaggerDoc("v1", new OpenApiInfo { Title = "WebApi", Version = "v1" }); 
 
       // 使用反射获取xml文件。并构造出文件的路径 
       var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; 
       var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); 
       // 启用xml注释.第二个参数启用控制器的注释，默认为false. 
       c.IncludeXmlComments(xmlPath, true); 
   });

再次启动项目查看界面

image.png

至此，基础的配置swagger显示注释已经实现了，那么如何调用我们接口那?

image.png

通过该界面，我们可以看到请求地址、请求方式、入参类型、输出参数等。

注：

通过设置取消显示警告：1591 ，可以去除方法和类上面的xml注释警告

如果实体类不在当前程序集下，需要同样方式配置实体类程序集的xml文档到swagger配置

2. swagger传递JWT

jwt是一个基于json的、用于在网络上声明某种主张的令牌，通常是用三部分组成：头信息，消息体，签名。他是一种双方之间传递安全信息的表述性声明规范。可以做权限验证的工具，但是目的不是为了数据加密和保护。虽然看似像是加密的数据，但是它并没有加密，不适合存储机密信息。

如果我们接口是需要传递token才可以访问，那么我们就需要对我们的swagger配置再进行改造

services.AddSwaggerGen(c => 
            { 
                c.SwaggerDoc("v1", new OpenApiInfo {Title = "WebApi", Version = "v1"}); 
 
                // 使用反射获取xml文件。并构造出文件的路径 
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; 
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); 
                // 启用xml注释.第二个参数启用控制器的注释，默认为false. 
                c.IncludeXmlComments(xmlPath, true); 
 
                var security = new Dictionary<string, IEnumerable<string>> {{"Bearer", new string[] { }}}; 
                c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme() 
                { 
                    Description = "JWT授权(数据将在请求头中进行传输) 在下方输入Bearer {token} 即可，注意两者之间有空格", 
                    Name = "Authorization", //jwt默认的参数名称 
                    In = ParameterLocation.Header, //jwt默认存放Authorization信息的位置(请求头中) 
                    Type = SecuritySchemeType.ApiKey, 
                }); 
                c.AddSecurityRequirement(new OpenApiSecurityRequirement 
                { 
                    { 
                        new OpenApiSecurityScheme 
                        { 
                            Reference = new OpenApiReference() 
                            { 
                                Id = "Bearer", 
                                Type = ReferenceType.SecurityScheme 
                            } 
                        }, 
                        Array.Empty<string>() 
                    } 
                }); 
            });

运行，查看界面，发现界面有所不同

image.png

虽然我手上没有token，但是我也没有写校验token的代码，所以我们就暂且看为一个头部传递的工具使用。jwt具体使用后续再讲。

token传递方式就是在Headers增加 Authorization:Bearer {token} ，然后需要在程序中配置校验token，当下我们只是模拟swagger在header中传递值。

在输入框输出：Bearer AABBCC

在Action中获取我们传输的数据

var token = HttpContext.Request.Headers["Authorization"];

image.png

3 参考文档

https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/web-api-help-pages-using-swagger?view=aspnetcore-5.0