Info
Version: | 1.0.8 |
Author(s): | E&M - Eldor Temirov |
Last Update: | Thursday, December 24, 2020 |
.NET Fiddle: | Create the first Fiddle |
Project Url: | https://github.com/eldortemirov/EM.UsingSwagger |
NuGet Url: | https://www.nuget.org/packages/EM.UsingSwagger |
Install
Install-Package EM.UsingSwagger
dotnet add package EM.UsingSwagger
paket add EM.UsingSwagger
EM.UsingSwagger Download (Unzip the "nupkg" after downloading)
Dependencies
- Microsoft.AspNetCore.Authentication.JwtBearer(>= 3.1.4)
- Microsoft.AspNetCore.Http.Abstractions(>= 2.2.0)
- Swashbuckle.AspNetCore(>= 5.4.1)
- Swashbuckle.AspNetCore.Annotations(>= 5.4.1)
- Swashbuckle.AspNetCore.Filters(>= 6.0.0)
- Swashbuckle.AspNetCore.Swagger(>= 5.6.3)
- Swashbuckle.AspNetCore.SwaggerGen(>= 5.5.0)
Tags
Существует атрибут SwaggerUnauthorize (SwaggerUnauthorize используется на методе или контроллере, его задача обеспечивает не требование API аутентификации, в методе или методов в контроллере);
Используйте атрибут SwaggerTag для описания и путь к документации контроллера.
Атрибут указан над именами контроллеров;
Существует SwaggerIgnore игнорирует свойства из swagger для запроса
Существует SwaggerAuthorize. Действует при использования методов AddSwaggerAllSecurityDefinitions и UseSwaggerAuthorizeUI;
Существует SwaggerDefaultValue, установить значения на свойству для swagger-запроса;
-------------------------------------------------------------------------------
There are two types of authentication: Basic Authentication and JWT Bearer Authentication;
There is a SwaggerUnauthorize attribute (SwaggerUnauthorize is used on a method or controller, its task does not require an authentication API, in a method or methods in the controller);
Use the SwaggerTag attribute to describe and the path to the controller documentation.
The attribute is indicated above the controller names;
There is a SwaggerIgnore ignores the properties from swagger to request;
There is a SwaggerAuthorize. Effective when using AddSwaggerAllSecurityDefinitions and UseSwaggerAuthorizeUI methods;
There is SwaggerDefaultValue set value to property for swagger request;.