feat: добавление swagger документации

TheBank/BankWebApi/BankWebApi.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk.Web">
+<Project Sdk="Microsoft.NET.Sdk.Web">
 
   <PropertyGroup>
     <TargetFramework>net9.0</TargetFramework>
@@ -15,6 +15,7 @@
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
     <PackageReference Include="Serilog.AspNetCore" Version="9.0.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="8.1.1" />
   </ItemGroup>
 
   <ItemGroup>
@@ -23,4 +24,8 @@
     <ProjectReference Include="..\BankDatabase\BankDatabase.csproj" />
   </ItemGroup>
 
+  <PropertyGroup>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <NoWarn>$(NoWarn);1591</NoWarn>
+  </PropertyGroup>
 </Project>

TheBank/BankWebApi/Controllers/ClerksController.cs

@@ -13,24 +13,43 @@ public class ClerksController(IClerkAdapter adapter) : ControllerBase
 {
     private readonly IClerkAdapter _adapter = adapter;
 
+    /// <summary>
+    /// получение всех записей клерков
+    /// </summary>
+    /// <returns>список клерков</returns>
     [HttpGet]
     public IActionResult GetAllRecords()
     {
         return _adapter.GetList().GetResponse(Request, Response);
     }
 
+    /// <summary>
+    /// получние записи о клерке по данным
+    /// </summary>
+    /// <param name="data">уникальный идентификатор или другое поле</param>
+    /// <returns>запись клерка</returns>
     [HttpGet("{data}")]
     public IActionResult GetRecord(string data)
     {
         return _adapter.GetElement(data).GetResponse(Request, Response);
     }
 
+    /// <summary>
+    /// создание записи клерка
+    /// </summary>
+    /// <param name="model">модель от пользователя</param>
+    /// <returns></returns>
     [HttpPost]
     public IActionResult Register([FromBody] ClerkBindingModel model)
     {
         return _adapter.RegisterClerk(model).GetResponse(Request, Response);
     }
 
+    /// <summary>
+    /// изменение записи клерка
+    /// </summary>
+    /// <param name="model">новая модель</param>
+    /// <returns></returns>
     [HttpPut]
     public IActionResult ChangeInfo([FromBody] ClerkBindingModel model)
     {

TheBank/BankWebApi/Program.cs

@@ -11,6 +11,7 @@ using BankWebApi.Infrastructure;
 using Microsoft.AspNetCore.Authentication.JwtBearer;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.IdentityModel.Tokens;
+using Microsoft.OpenApi.Models;
 using Serilog;
 using System.IdentityModel.Tokens.Jwt;
 using System.Security.Claims;
@@ -23,7 +24,40 @@ builder.Services.AddControllers();
 using var loggerFactory = new LoggerFactory();
 loggerFactory.AddSerilog(new LoggerConfiguration().ReadFrom.Configuration(builder.Configuration).CreateLogger());
 builder.Services.AddSingleton(loggerFactory.CreateLogger("Any"));
+builder.Services.AddSwaggerGen(c =>
+{
+    c.SwaggerDoc("v1", new OpenApiInfo { Title = "Bank API", Version = "v1" });
 
+    // <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> XML-<2D><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> (<28><><EFBFBD><EFBFBD> <20><><EFBFBD> <20><><EFBFBD><EFBFBD>)
+    var xmlFile = $"{System.Reflection.Assembly.GetExecutingAssembly().GetName().Name}.xml";
+    var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
+    c.IncludeXmlComments(xmlPath, includeControllerXmlComments: true);
+
+    // <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> JWT-<2D><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> <20> Swagger UI
+    c.AddSecurityDefinition("Bearer", new OpenApiSecurityScheme
+    {
+        Description = "JWT Authorization header using the Bearer scheme. Example: 'Bearer {token}'",
+        Name = "Authorization",
+        In = ParameterLocation.Header,
+        Type = SecuritySchemeType.Http,
+        Scheme = "bearer",
+        BearerFormat = "JWT"
+    });
+    c.AddSecurityRequirement(new OpenApiSecurityRequirement
+    {
+        {
+            new OpenApiSecurityScheme
+            {
+                Reference = new OpenApiReference
+                {
+                    Type = ReferenceType.SecurityScheme,
+                    Id = "Bearer"
+                }
+            },
+            []
+        }
+    });
+});
 builder.Services.AddAuthorization();
 builder.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
     .AddJwtBearer(options =>
@@ -63,6 +97,12 @@ var app = builder.Build();
 if (app.Environment.IsDevelopment())
 {
     app.MapOpenApi();
+    app.UseSwagger();
+    app.UseSwaggerUI(c =>
+    {
+        c.SwaggerEndpoint("/swagger/v1/swagger.json", "Bank API V1");
+        c.RoutePrefix = "swagger"; // Swagger UI <20><><EFBFBD><EFBFBD><EFBFBD> <20><><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD><EFBFBD> <20><> /swagger
+    });
 }
 if (app.Environment.IsProduction())
 {
@@ -75,7 +115,7 @@ if (app.Environment.IsProduction())
 }
 
 app.UseHttpsRedirection();
-
+app.UseAuthentication();
 app.UseAuthorization();
 
 app.Map("/login/{username}", (string username) =>