EasilyNET.WebCore.Swagger 3.24.709.105

There is a newer version of this package available.
See the version list below for details.
dotnet add package EasilyNET.WebCore.Swagger --version 3.24.709.105
                    
NuGet\Install-Package EasilyNET.WebCore.Swagger -Version 3.24.709.105
                    
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="3.24.709.105" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="EasilyNET.WebCore.Swagger" Version="3.24.709.105" />
                    
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 3.24.709.105
                    
#r "nuget: EasilyNET.WebCore.Swagger, 3.24.709.105"
                    
#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=3.24.709.105
                    
Install EasilyNET.WebCore.Swagger as a Cake Addin
#tool nuget:?package=EasilyNET.WebCore.Swagger&version=3.24.709.105
                    
Install EasilyNET.WebCore.Swagger as a Cake Tool

EasilyNET.WebCore.Swagger

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

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

添加默认值显示 代码示例

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

最新变化

  • SwaggerIgnoreAttribute由于官方已经提供了同名特性,所以这里删除相关代码.

可用特性

  • 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.513.101 0 5/13/2025
4.25.506.150 107 5/6/2025
4.25.429.162 134 4/29/2025
4.25.429.103 157 4/29/2025
4.25.411.142 131 4/11/2025
4.25.409.92 160 4/9/2025
4.25.403.133 158 4/3/2025
4.25.319.113 150 3/19/2025
4.25.312.103 159 3/12/2025
4.25.227.135 102 2/27/2025
4.25.221.115 101 2/21/2025
4.25.212.95 104 2/12/2025
4.25.211.140 107 2/11/2025
4.25.124.223 102 1/24/2025
4.25.116.110 86 1/16/2025
4.25.115.121 60 1/15/2025
4.25.114.172 92 1/14/2025
4.25.109.111 90 1/9/2025
4.25.108.182 88 1/8/2025
4.25.108.160 96 1/8/2025
4.25.1.1 115 1/1/2025
3.24.1224.141 94 12/24/2024
3.24.1216.116 118 12/16/2024
3.24.1206.100 108 12/6/2024
3.24.1205.171 113 12/5/2024
3.24.1202.150 101 12/2/2024
3.24.1126.231 102 11/26/2024
3.24.1126.172 102 11/26/2024
3.24.1126.114 97 11/26/2024
3.24.1126.104 94 11/26/2024
3.24.1125.181 85 11/25/2024
3.24.1125.104 102 11/25/2024
3.24.1121.183 112 11/21/2024
3.24.1120.183 105 11/20/2024
3.24.1119.31 105 11/18/2024
3.24.1115.143 87 11/15/2024
3.24.1113.100 103 11/13/2024
3.24.1112.125 114 11/12/2024
3.24.1107.140 102 11/7/2024
3.24.1107.54 103 11/7/2024
3.24.1107.34 100 11/7/2024
3.24.1105.111 106 11/5/2024
3.24.1103.31 107 11/2/2024
3.24.1103 106 11/2/2024
3.24.1031.135 101 10/31/2024
3.24.1031.112 94 10/31/2024
3.24.1031.104 96 10/31/2024
3.24.1029.142 117 10/29/2024
3.24.1025.30 108 10/24/2024
3.24.1022.142 94 10/22/2024
3.24.1018.204 160 10/18/2024
3.24.1018.175 150 10/18/2024
3.24.1018.166 150 10/18/2024
3.24.1018.93 155 10/18/2024
3.24.1017.42 102 10/16/2024
3.24.1016.161 99 10/16/2024
3.24.1015.231 109 10/15/2024
3.24.1015.14 101 10/14/2024
3.24.1012.114 108 10/12/2024
3.24.1009.115 112 10/9/2024
3.24.1008.160 94 10/8/2024
3.24.1008.133 101 10/8/2024
3.24.1007.185 93 10/7/2024
3.24.1003.33 107 10/2/2024
3.24.1002.162 101 10/2/2024
3.24.929.143 102 9/29/2024
3.24.929.141 134 9/29/2024
3.24.929.131 102 9/29/2024
3.24.929.122 104 9/29/2024
3.24.926.184 112 9/26/2024
3.24.926.182 101 9/26/2024
3.24.926.175 110 9/26/2024
3.24.924.160 100 9/24/2024
3.24.924.133 125 9/24/2024
3.24.924.124 103 9/24/2024
3.24.924.10 117 9/23/2024
3.24.924.1 101 9/23/2024
3.24.923.234 110 9/23/2024
3.24.923.232 107 9/23/2024
3.24.923.155 111 9/23/2024
3.24.919.92 114 9/19/2024
3.24.914.125 136 9/14/2024
3.24.914.115 123 9/14/2024
3.24.914.111 143 9/14/2024
3.24.911.95 123 9/11/2024
3.24.908.215 119 9/8/2024
3.24.904.200 116 9/4/2024
3.24.828.163 137 8/28/2024
3.24.820.173 140 8/20/2024
3.24.814.92 134 8/14/2024
3.24.812.115 155 8/12/2024
3.24.802.100 131 8/2/2024
3.24.801.162 104 8/1/2024
3.24.801.160 126 8/1/2024
3.24.730.164 91 7/30/2024
3.24.730.91 98 7/30/2024
3.24.724.91 93 7/24/2024
3.24.718.105 145 7/18/2024
3.24.716.95 119 7/16/2024
3.24.712.94 116 7/12/2024
3.24.710.14 122 7/9/2024
3.24.709.105 134 7/9/2024
3.24.704.94 137 7/4/2024
3.24.701.90 126 7/1/2024
3.24.628.114 129 6/28/2024
3.24.627.145 121 6/27/2024
3.24.620.160 130 6/20/2024
3.24.613.115 122 6/13/2024
3.24.612.95 108 6/12/2024
3.24.528.90 123 5/28/2024
3.24.522.84 139 5/22/2024
3.24.512.213 106 5/12/2024
3.24.508.112 130 5/8/2024
2.2024.428.71 126 4/28/2024
2.2024.427.1128 136 4/27/2024
2.2.72 145 4/14/2024
2.2.71 137 4/12/2024
2.2.8 111 4/26/2024
2.2.6 126 4/10/2024
2.2.5 146 3/26/2024
2.2.4 131 3/25/2024
2.2.3 148 3/24/2024
2.2.2 171 3/21/2024
2.2.1 149 3/20/2024
2.2.0 154 3/13/2024
2.1.9 166 2/21/2024
2.1.8 127 2/18/2024
2.1.7 143 2/16/2024
2.1.6 140 2/14/2024
2.1.5 134 2/14/2024
2.1.4 159 2/9/2024
2.1.3 158 2/8/2024
2.1.2 147 2/5/2024
2.1.1.2 215 12/26/2023
2.1.1.1 167 12/26/2023
2.1.1 168 12/25/2023
2.1.0 163 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 172 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 159 9/12/2023
1.8.6 215 8/31/2023
1.8.5 841 8/25/2023
1.8.4 192 8/24/2023
1.8.3 216 8/23/2023
1.8.2 244 8/22/2023
1.8.1 217 8/18/2023
1.8.0 188 8/15/2023
1.7.9 224 8/11/2023
1.7.8 175 8/11/2023
1.7.7 205 8/10/2023
1.7.6 195 8/9/2023
1.7.5 241 8/9/2023
1.7.4 299 8/3/2023
1.7.3 218 8/1/2023
1.7.2 200 7/31/2023
1.7.1 181 7/27/2023
1.7.0 205 7/25/2023
1.6.9 228 7/25/2023
1.6.8 198 7/24/2023
1.6.7 223 7/20/2023
1.6.6 206 7/19/2023
1.6.5 181 7/19/2023
1.6.4 195 7/17/2023
1.6.3 184 7/17/2023
1.6.2 260 7/12/2023
1.6.1 266 6/30/2023
1.6.0 185 6/26/2023
1.5.9 224 6/22/2023
1.5.8 249 6/15/2023
1.5.7.1 234 6/14/2023
1.5.7 243 6/14/2023
1.5.6.2 246 6/7/2023
1.5.6.1 217 6/7/2023
1.5.6 216 6/7/2023
1.5.5.2 269 5/26/2023
1.5.5.1 232 5/26/2023
1.5.5 234 5/26/2023
1.5.4.4 209 5/25/2023
1.5.4.3 232 5/23/2023
1.5.4.2 304 5/17/2023
1.5.4.1 204 5/16/2023
1.5.4 294 5/11/2023
1.5.3 217 5/11/2023
1.5.2 242 5/10/2023
1.5.1 203 5/10/2023
1.5.0 252 5/6/2023
1.4.0 224 5/5/2023
1.3.9 276 4/23/2023