📝 Создаем красивую документацию API с помощью Scalar в ASP.NET Core

Устали от скучного Swagger UI? Добро пожаловать в новый мир API-документации с ярким и современным интерфейсом Scalar, который изменит ваше представление о том, как должна выглядеть документация API!

Scalar — это инструмент, который помогает создавать привлекательную документацию для наших API. В отличие от стандартной документации Swagger, которая может выглядеть немного устаревшей, Scalar предлагает свежий, современный интерфейс. Благодаря аккуратному дизайну разработчикам проще находить нужные API для тестирования.

В этой статье мы рассмотрим, как использовать Scalar для документирования API в ASP.NET Core Web API, чтобы заменить стандартный Swagger UI.

Данная статья является переводом другой статьи. С оригиналом вы можете ознакомиться по ссылке.

Установка Scalar

Откройте NuGet Package Manager, найдите и установите пакет Scalar.AspNetCore:

Установка Scalar

Настройка Scalar

Откройте файл Program.cs и замените конфигурацию Swagger по умолчанию.

Было так:

А должно стать так:

#️⃣ Библиотека шарписта

Больше полезных материалов вы найдете на нашем телеграм-канале «Библиотека шарписта»

Аутентификация Bearer

Мы также можем добавить заголовок аутентификации Bearer в документацию Scalar. Просто замените в Program.cs конфигурацию builder.Services.AddSwaggerGen(); на такую:

Ниже приведён полный файл Program.cs с нужными изменениями:

Настройки запуска

Чтобы Scalar автоматически открывался при запуске приложения, нужно скорректировать файл LaunchSettings.json, который находится в папке Properties.

Настройки запуска

Откройте LaunchSettings.json и замените "launchUrl": "swagger" на "launchUrl": "scalar/v1":

🛠️ API-документация без головной боли: ТОП-11 инструментов

Запуск приложения

Теперь запускаем приложение:

Запуск приложения

Пример тестового запроса:

Пример тестового запроса

Наша документация для API теперь выглядит потрясающе!

Использование Scalar для документирования API даёт множество преимуществ и упрощает работу разработчиков. Интерфейс выглядит красиво, в боковом меню легко найти нужные разделы без постоянной прокрутки, а функция Test Request позволяет сразу тестировать эндпоинты из документации.

Исходный код проекта можно найти здесь.

#️⃣🎓 Библиотека C# для собеса

Подтянуть свои знания по C# вы можете на нашем телеграм-канале «Библиотека C# для собеса»

#️⃣🧩 Библиотека задач по C#

Интересные задачи по C# для практики можно найти на нашем телеграм-канале «Библиотека задач по C#»