EasilyNET.WebCore.Swagger 2.2.5

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package EasilyNET.WebCore.Swagger --version 2.2.5
                    


                    

                
NuGet\Install-Package EasilyNET.WebCore.Swagger -Version 2.2.5
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="EasilyNET.WebCore.Swagger" Version="2.2.5" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="EasilyNET.WebCore.Swagger" Version="2.2.5" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="EasilyNET.WebCore.Swagger" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add EasilyNET.WebCore.Swagger --version 2.2.5
                    


                    

                
#r "nuget: EasilyNET.WebCore.Swagger, 2.2.5"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#addin nuget:?package=EasilyNET.WebCore.Swagger&version=2.2.5
                    


                            Install EasilyNET.WebCore.Swagger as a Cake Addin
                        

                    

                
#tool nuget:?package=EasilyNET.WebCore.Swagger&version=2.2.5
                    


                            Install EasilyNET.WebCore.Swagger as a Cake Tool

EasilyNET.WebCore.Swagger

将 Swagger 的扩展独立出来,避免 WebCore 的过度依赖.

  • 新增 Swagger 页面参数忽略.比如某些默认参数不需要调用者传入,并且也不希望他看见
  • 接口隐藏,或者控制器隐藏

添加默认值显示 代码示例

  • 在 Swagger 文档中给需要 Authorize 的接口添加 🔒

可用特性

  • ApiGroupAttribute 对控制器进行分组.便于将特有的功能分到一个组方便管理.
  • HiddenApiAttribute 隐藏控制器或者单个接口.
  • SwaggerIgnoreAttribute 忽略接口参数或者传入实体的属性 代码示例

如何使用?

// 添加 Swagger 服务
private const string name = $"{title}-{version}";

private const string version = "v1";
private const string title = "WebApi.Test";

builder.Services.AddSwaggerGen(c =>
{
    // 配置默认的文档信息
    c.SwaggerDoc(name, new()
    {
        Title = title,
        Version = version,
        Description = "Console.WriteLine(\"🐂🍺\")"
    });
    // 这里使用EasilyNET提供的扩展配置.
    c.EasilySwaggerGenOptions(name);
    // 配置认证方式
    c.AddSecurityDefinition("Bearer", new()
    {
        Description = "JWT Authorization header using the Bearer scheme. Example: \"Authorization: Bearer {token}\"",
        Name = "Authorization",
        In = ParameterLocation.Header,
        Type = SecuritySchemeType.ApiKey,
        Scheme = "Bearer"
    });
});

...

// 注册 Swagger 中间件
app.UseSwagger().UseSwaggerUI(c =>
{
    // 配置默认文档
    c.SwaggerEndpoint($"/swagger/{name}/swagger.json", $"{title} {version}");
    // 使用EasilyNET提供的扩展配置
    c.EasilySwaggerUIOptions();
});
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
4.25.403.133 0 4/3/2025
4.25.319.113 133 3/19/2025
4.25.312.103 147 3/12/2025
4.25.227.135 92 2/27/2025
4.25.221.115 89 2/21/2025
4.25.212.95 92 2/12/2025
4.25.211.140 96 2/11/2025
4.25.124.223 92 1/24/2025
4.25.116.110 74 1/16/2025
4.25.115.121 51 1/15/2025
4.25.114.172 79 1/14/2025
4.25.109.111 80 1/9/2025
4.25.108.182 75 1/8/2025
4.25.108.160 83 1/8/2025
4.25.1.1 103 1/1/2025
3.24.1224.141 84 12/24/2024
3.24.1216.116 103 12/16/2024
3.24.1206.100 98 12/6/2024
3.24.1205.171 102 12/5/2024
3.24.1202.150 90 12/2/2024
3.24.1126.231 90 11/26/2024
3.24.1126.172 91 11/26/2024
3.24.1126.114 86 11/26/2024
3.24.1126.104 83 11/26/2024
3.24.1125.181 75 11/25/2024
3.24.1125.104 91 11/25/2024
3.24.1121.183 101 11/21/2024
3.24.1120.183 94 11/20/2024
3.24.1119.31 95 11/18/2024
3.24.1115.143 78 11/15/2024
3.24.1113.100 95 11/13/2024
3.24.1112.125 104 11/12/2024
3.24.1107.140 93 11/7/2024
3.24.1107.54 93 11/7/2024
3.24.1107.34 92 11/7/2024
3.24.1105.111 96 11/5/2024
3.24.1103.31 97 11/2/2024
3.24.1103 97 11/2/2024
3.24.1031.135 90 10/31/2024
3.24.1031.112 85 10/31/2024
3.24.1031.104 87 10/31/2024
3.24.1029.142 108 10/29/2024
3.24.1025.30 99 10/24/2024
3.24.1022.142 84 10/22/2024
3.24.1018.204 150 10/18/2024
3.24.1018.175 140 10/18/2024
3.24.1018.166 139 10/18/2024
3.24.1018.93 145 10/18/2024
3.24.1017.42 94 10/16/2024
3.24.1016.161 92 10/16/2024
3.24.1015.231 101 10/15/2024
3.24.1015.14 94 10/14/2024
3.24.1012.114 101 10/12/2024
3.24.1009.115 102 10/9/2024
3.24.1008.160 87 10/8/2024
3.24.1008.133 93 10/8/2024
3.24.1007.185 85 10/7/2024
3.24.1003.33 98 10/2/2024
3.24.1002.162 92 10/2/2024
3.24.929.143 93 9/29/2024
3.24.929.141 123 9/29/2024
3.24.929.131 93 9/29/2024
3.24.929.122 95 9/29/2024
3.24.926.184 104 9/26/2024
3.24.926.182 92 9/26/2024
3.24.926.175 102 9/26/2024
3.24.924.160 91 9/24/2024
3.24.924.133 115 9/24/2024
3.24.924.124 92 9/24/2024
3.24.924.10 106 9/23/2024
3.24.924.1 91 9/23/2024
3.24.923.234 101 9/23/2024
3.24.923.232 98 9/23/2024
3.24.923.155 101 9/23/2024
3.24.919.92 106 9/19/2024
3.24.914.125 128 9/14/2024
3.24.914.115 115 9/14/2024
3.24.914.111 134 9/14/2024
3.24.911.95 116 9/11/2024
3.24.908.215 111 9/8/2024
3.24.904.200 108 9/4/2024
3.24.828.163 128 8/28/2024
3.24.820.173 132 8/20/2024
3.24.814.92 125 8/14/2024
3.24.812.115 145 8/12/2024
3.24.802.100 121 8/2/2024
3.24.801.162 94 8/1/2024
3.24.801.160 114 8/1/2024
3.24.730.164 83 7/30/2024
3.24.730.91 88 7/30/2024
3.24.724.91 85 7/24/2024
3.24.718.105 136 7/18/2024
3.24.716.95 109 7/16/2024
3.24.712.94 106 7/12/2024
3.24.710.14 113 7/9/2024
3.24.709.105 125 7/9/2024
3.24.704.94 128 7/4/2024
3.24.701.90 117 7/1/2024
3.24.628.114 119 6/28/2024
3.24.627.145 113 6/27/2024
3.24.620.160 121 6/20/2024
3.24.613.115 114 6/13/2024
3.24.612.95 101 6/12/2024
3.24.528.90 114 5/28/2024
3.24.522.84 129 5/22/2024
3.24.512.213 98 5/12/2024
3.24.508.112 120 5/8/2024
2.2024.428.71 116 4/28/2024
2.2024.427.1128 127 4/27/2024
2.2.72 137 4/14/2024
2.2.71 130 4/12/2024
2.2.8 104 4/26/2024
2.2.6 117 4/10/2024
2.2.5 136 3/26/2024
2.2.4 122 3/25/2024
2.2.3 139 3/24/2024
2.2.2 162 3/21/2024
2.2.1 139 3/20/2024
2.2.0 143 3/13/2024
2.1.9 158 2/21/2024
2.1.8 118 2/18/2024
2.1.7 135 2/16/2024
2.1.6 132 2/14/2024
2.1.5 125 2/14/2024
2.1.4 150 2/9/2024
2.1.3 150 2/8/2024
2.1.2 139 2/5/2024
2.1.1.2 207 12/26/2023
2.1.1.1 158 12/26/2023
2.1.1 159 12/25/2023
2.1.0 154 12/17/2023
2.0.11 229 12/6/2023
2.0.1 217 11/15/2023
2.0.0 169 11/14/2023
1.9.1 169 11/1/2023
1.9.0 171 10/19/2023
1.9.0-preview2 314 10/12/2023
1.9.0-preview1 151 10/12/2023
1.8.9 204 10/11/2023
1.8.8 182 10/11/2023
1.8.7-rc2 155 9/21/2023
1.8.7-rc1 158 9/12/2023
1.8.6 214 8/31/2023
1.8.5 838 8/25/2023
1.8.4 191 8/24/2023
1.8.3 215 8/23/2023
1.8.2 243 8/22/2023
1.8.1 216 8/18/2023
1.8.0 187 8/15/2023
1.7.9 223 8/11/2023
1.7.8 174 8/11/2023
1.7.7 204 8/10/2023
1.7.6 194 8/9/2023
1.7.5 240 8/9/2023
1.7.4 297 8/3/2023
1.7.3 217 8/1/2023
1.7.2 199 7/31/2023
1.7.1 180 7/27/2023
1.7.0 204 7/25/2023
1.6.9 227 7/25/2023
1.6.8 197 7/24/2023
1.6.7 221 7/20/2023
1.6.6 204 7/19/2023
1.6.5 179 7/19/2023
1.6.4 193 7/17/2023
1.6.3 182 7/17/2023
1.6.2 258 7/12/2023
1.6.1 264 6/30/2023
1.6.0 183 6/26/2023
1.5.9 221 6/22/2023
1.5.8 246 6/15/2023
1.5.7.1 231 6/14/2023
1.5.7 239 6/14/2023
1.5.6.2 243 6/7/2023
1.5.6.1 214 6/7/2023
1.5.6 213 6/7/2023
1.5.5.2 265 5/26/2023
1.5.5.1 229 5/26/2023
1.5.5 233 5/26/2023
1.5.4.4 206 5/25/2023
1.5.4.3 229 5/23/2023
1.5.4.2 301 5/17/2023
1.5.4.1 200 5/16/2023
1.5.4 291 5/11/2023
1.5.3 214 5/11/2023
1.5.2 239 5/10/2023
1.5.1 200 5/10/2023
1.5.0 249 5/6/2023
1.4.0 221 5/5/2023
1.3.9 273 4/23/2023