Bing.Extensions.Swashbuckle

Bing.Extensions.Swashbuckle是扩展Swashbuckle.AspNetCore一些常用操作，便于使用以及过滤。

Nuget

Nuget	版本号	说明
Bing.Extensions.Swashbuckle

功能

• 支持多版本分组
• 支持多API分组功能
• 支持文件上传参数
• 支持添加通用参数
• 支持自定义请求头
• 支持自定义响应头
• 支持安全请求
• 支持显示授权信息
• 支持自定义Url显示模式。首字母小写、首字母大写、全小写、全大写
• 支持显示枚举描述
• 支持Swagger文档授权登录功能
• 支持默认值设置
• 支持控制器排序
• 支持Token令牌存储
• 支持控制器方法计数
• 支持全局响应包装功能Bing.Extensions.Swashbuckle

依赖类库

• Swashbuckle.AspNetCore

使用方式

显示枚举描述

用于在请求实体与响应实体当中，显示枚举的描述信息，需要在枚举上面添加 [Description("xxx")] 特性，方可在文档中显示每个枚举的注释信息。

public enum EnumSample
{
    [Description("老大")]
    One = 1,
    [Description("老二")]
    Two = 2,
    [Description("老三")]
    Three = 3
}

// Startup.cs
services.AddSwaggerGen(c =>
{
    ...
    c.ShowEnumDescription();
});

作者

简玄冰

贡献与反馈

如果你在阅读或使用Bing中任意一个代码片断时发现Bug，或有更佳实现方式，请通知我们。

为了保持代码简单，目前很多功能只建立了基本结构，细节特性未进行迁移，在后续需要时进行添加，如果你发现某个类无法满足你的需求，请通知我们。

你可以通过github的Issue或Pull Request向我们提交问题和代码，如果你更喜欢使用QQ进行交流，请加入我们的交流QQ群。

对于你提交的代码，如果我们决定采纳，可能会进行相应重构，以统一代码风格。

对于热心的同学，将会把你的名字放到贡献者名单中。

免责声明

• 虽然我们对代码已经进行高度审查，并用于自己的项目中，但依然可能存在某些未知的BUG，如果你的生产系统蒙受损失，Bing 团队不会对此负责。
• 出于成本的考虑，我们不会对已发布的API保持兼容，每当更新代码时，请注意该问题。

开源地址

https://github.com/bing-framework/Bing.Extensions.Swashbuckle

License

MIT

这意味着你可以在任意场景下使用 Bing 应用框架而不会有人找你要钱。

Bing 会尽量引入开源免费的第三方技术框架，如有意外，还请自行了解。