Язык программирования C#9 и платформа .NET5 - Троелсен Эндрю

На нашем сайте KnigaRead.com Вы можете абсолютно бесплатно читать книгу онлайн Троелсен Эндрю, "Язык программирования C#9 и платформа .NET5" бесплатно, без регистрации.

Назад 1 ... 598 599 600 601 602 ... 642 Вперед

Перейти на страницу:

Пользовательский интерфейс Swagger базируется на веб-интерфейсе и позволяет интерактивным образом исследовать конечные точки приложения, а также тестировать их (как делалось ранее в этой главе). Его можно расширить, добавляя документацию в сгенерированный файл

swagger.json

Обновление обращений к Swagger в классе Startup

Стандартный шаблон проекта API добавляет код для генерирования файла

swagger.json

в метод

ConfigureService()

класса

Startup

services.AddSwaggerGen(c =>

{

c.SwaggerDoc("v1", new OpenApiInfo { Title = "AutoLot.Api", Version = "v1" });

});

Первое изменение стандартного кода предусматривает добавление метаданных к

OpenApiInfo

. Модифицируйте вызов

AddSwaggerGen()

следующим образом, чтобы обновить заголовок и добавить описание и сведения о лицензии:

services.AddSwaggerGen(c =>

{

c.SwaggerDoc("v1",

new OpenApiInfo

{

 Title = "AutoLot Service",

Version = "v1",

 Description = "Service to support the AutoLot dealer site",

 License = new OpenApiLicense

 {

 Name = "Skimedic Inc",

 Url = new Uri("http://www.skimedic.com")

 }

});

Следующий шаг связан с переносом вызовов

UseSwagger()

UseSwaggerUI()

из блока, предназначенного только для среды разработки, в главный путь выполнения внутри метода

Configure()

. Кроме того, поменяйте заголовок

"AutoLot.Api vl"

на

"AutoLot Service vl"

public void Configure(IApplicationBuilder app, IWebHostEnvironment env,

ApplicationDbContext context)

{

if (env.IsDevelopment())

{

    // Если среда разработки, тогда отображать отладочную информацию.

app.UseDeveloperExceptionPage();

 // Первоначальный код:

 // app.UseSwagger();

 // app.UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json",

<b>    //                                         &quot;AutoLot.Api v1&quot;));</b>

// Инициализировать базу данных.

if (Configuration.GetValue<bool>("RebuildDataBase"))

{

SampleDataInitializer.ClearAndReseedDatabase(context);

}

// Включить промежуточное ПО для обслуживания сгенерированного

// файла Swagger как конечной точки JSON.

 app.UseSwagger();

  // Включить промежуточное ПО для обслуживания пользовательского

// интерфейса Swagger (HTML, JS, CSS и т.д.), указывая конечную

// точку JSON для Swagger

 app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json",

"AutoLot Service

v1"); });

...

}

В предыдущем коде используется

Swagger(app.UseSwagger())

и пользовательский интерфейс Swagger(

app.useSwaggerUI()

). В нем также конфигурируется конечная точка для файла

swagger.json

Добавление файла XML-документации

Инфраструктура .NET Core способна генерировать файл XML-документации для вашего проекта, исследуя методы на предмет наличия комментариев с тремя символами прямой косой черты (

///

). Чтобы включить такую функциональность в Visual Studio, щелкните правой кнопкой мыши на имени проекта

AutoLot.Api

и в контекстном меню выберите пункт Properties (Свойства). В открывшемся диалоговом окне Properties (Свойства) перейдите на вкладку Build (Сборка), отметьте флажок XML documentation file (Файл XML-документации) и укажите в качестве имени файла

AutoLot.Api.xml

. Кроме того, введите 1591 в текстовом поле Suppress warnings (Подавлять предупреждения), как показано на рис. 30.3.