Изисквания: Скаларът е доста мощен и може автоматично да генерира HTTP код за повиквания на различни езици от API документацията, използвайки Scalar вместо Swagger за показване на API документацията.
След пускането на .NET 9 ASP.NET официалният екип на Core обяви, че Swashbuckle.AspNetCore (проект, предоставящ инструмента Swagger за ASP.NET Core API) ще бъде премахнат от шаблона на ASP.NET Core Web API. Това означава, че в бъдеще, когато създаваме Web API проекти, документацията на Swagger API вече няма да се генерира автоматично. Затова днес нека опитаме да използваме Scalar за интерактивна документация на API в нашия проект EasySQLite .NET 9.
Връзка:Входът към хиперлинк е видим.
Причините за отстраняването на Суагър могат да се обобщят по следния начин:
- Лоша поддръжка на Swashbuckle: Проектът Swashbuckle вече не се поддържа активно от собственици на общности, много проблеми остават нерешени, а официална версия, съвместима с .NET 8, не е пусната.
- Обръщайки се към Microsoft.AspNetCore.OpenApi: Екипът на ASP.NET Core ще подобри възможностите на Microsoft.AspNetCore.OpenApi, за да замени Swashbuckle и да позволи генериране на документация за OpenAPI.
- Съществуващи алтернативи: Освен Swashbuckle, други проекти като NSwag поддържат генериране на документация с OpenAPI и генериране на клиент/сървър код, което позволява на разработчиците да изберат подходящото решение според нуждите на проекта.
- Подобрена поддръжка на вградени API: От Core ASP.NET 3.1 насам насам фреймуъркът предоставя поддръжка на метаданни като ApiExplorer. В комбинация с вградената поддръжка на .http файлове в Visual Studio и Visual Studio Code, опитът при тестване и отстраняване на грешки от API е още по-добър.
- Популяризиране на OpenAPI като основен компонент: екипът на ASP.NET Core планира допълнително да подобри интеграцията с OpenAPI в .NET 9, превръщайки я в основен компонент, фокусиран върху генерирането на JSON-форматирана OpenAPI документация.
Скалар
Scalar е мощен и лесен за използване инструмент за генериране на API клиент и документация, подходящ за API проекти от всякакъв размер, поддържащ множество програмни езици и платформи.
Отворен код на адрес:Входът към хиперлинк е видим.
ASP.NET Core интегрира Scalar
Интегрирана документация:Входът към хиперлинк е видим.
Създайте проект ASP.NET Core 9, посочен по следния начин:
Добавете услуги и скаларен междинен софтуер в Program.cs, като кодът е следният:
Редакция WeatherForecastController.cs контролер, кодът е следният:
Стартирайте проекта, отворете браузъра си и посетете:http://localhost:5088/api-docs, както е показано на фигурата по-долу:
Можете да изберете да генерирате специфичен код за повикване за HTTP библиотеки на различни езици. Като пример C# HttpClient библиотеката, генерираният код е следният:
Поддържа и онлайн тестване на интерфейси. Кликнете върху бутона Заявка за тест, попълнете данните от публикацията и след това натиснете изпрати, за да изпратите заявката, както е показано по-долу:
Персонализирайте стандартния HTTP клиент. За C# екипи искаме да отворим API документационния интерфейс, който автоматично показва кода за повикване на C# HttpClient. Ако не искате да избирате ръчно при първи път, конфигурирайте по следния начин:
Изтрийте функцията Ask AI и премахнете бутона Ask AI Agent. Тази функция изглежда малко излишна. Кодът е следният:
Както е показано по-долу:
След изтриването, както е показано по-долу:
По подобен начин, деактивирайте функционалността на MCP, кодирайте по следния начин:
Пълната конфигурация е следната:
Добавете JWT автентикация и пренесете заглавието на заявкатаЖетон на носителя
Добавете изисквания за сигурност към цялата документация на OpenAPI, кодовете по следния начин:
Както е показано по-долу:
OpenID Connect (OIDC):Входът към хиперлинк е видим.
Препратка:
Входът към хиперлинк е видим.
Входът към хиперлинк е видим. |
Публикувано вПреди 5 минути
|
|
|
|
Хазяин|
Публикувано вПреди 1 минута
|
