ContosoPizzaWebApiDemo
1.0.0
Простая демонстрация веб -API с документацией Swagger, пользовательской обработкой ошибок, модульными тестами, JSONPATCH и тестером HTTPClient. Особенности видео на YouTube в учебном стиле для некоторых тем.
Цель этого проекта GitHub - продемонстрировать простое приложение Crud Web API с дополнительными учебниками (включая видео на YouTube) и ссылки, включая чванство, модульное тестирование, JSONPATCH, пользовательская обработка и отображение ошибок, тестировщики клиентов и т. Д.
Решение Visual Studio имеет три проекта: Contosopizza (Web API), Contosopizza.tests (модульные тесты) и WebApiclient (простое приложение консоли HTTPClient)
Контроллер, модель и сервисные классы с кратким изложением участника проекта Contosopizza Web API показаны ниже.
Это простой веб -API, который следует за стандартным шаблоном CRUD (создавать, читать, обновить и удалять). Демо -изображения операций API показаны ниже по категории.
Вот несколько захватов экрана, показывающих демонстрацию веб -API JSONPatch.
Вот ссылка на код.
[
{
"value": "ModifiedPizza",
"path": "/name",
"op": "replace"
}
]
Это отличное ориентировочное видео, если вы хотите узнать больше о настройке, установке и использовании JSONPatch для вашего проекта Web API.
Обновление данных с помощью jsonpatch | Серия новичков для веб -API
JsonPatch в ASP.net Core Web API
Этот учебник и демонстрационный проект покажут, как настроить, настроить и кодировать простой пользовательский обработчик ошибок для проекта Contoso Pizza Web API.
Разработчики должны планировать невозможные ошибки в коде. Проект Contoso Pizza Web API демонстрирует, как это сделать. В демонстрации создается конечная точка, которая всегда бросает нездоровое исключение. Проект имеет пользовательский контроллер ошибок, который обрабатывает и регистрирует исключения перед возвратом стандартного объекта модели задачи пользователю. Контроллер ошибок указан в конфигурации программы для маршрута на пользовательский контроллер ошибок, когда не работает в среде разработки. Среда разработки указана в настройках профиля запуска отладки, причем значение по умолчанию является производством, если не указано иное.
Чтобы увидеть различия в отображении ошибок между разработкой и производством, сначала запустите API в режиме разработки. Проверьте конечную точку, которая всегда запускает нездоровое исключение. В пользовательском интерфейсе Swagger вы можете увидеть данные ответа и исключения. Окно браузера имеет отдельное и элегантное представление разработчика результатов ошибки.
Чтобы запустить API в производственном режиме, удалите переменную среды или вручную установите значение для производства. Поскольку Swagger UI не работает в производственном режиме, вам нужно будет проверить конечную точку API вручную с помощью URL. Окончательным результатом для пользователя является общая ошибка с идентификатором. Пользователь создаст билет с этой информацией. Затем компания может завершить подробное устранение неполадок, соответствующая идентификатору ошибки с более подробным внутренним журналом.
Этот учебник и демонстрационный проект покажут вам, как добавлять, настройку, настройку и проверку документации Swagger в ваш проект разработчика WebAPI. Окончательные результаты в этом коде.
Swashbuckle и Swagger - это два популярных инструмента, используемых для создания документации разработчика для веб -API. Swashbuckle - это пакет, который можно добавить в проект ASP.NET Core Web API для интеграции пользовательского интерфейса Swagger. Он имеет три основных компонента: Swashbuckle.aspnetcore.swagger, которая представляет собой модель объекта Swagger и промежуточное программное обеспечение для обнаружения объектов SwaggerDocument как конечные точки JSON; Swashbuckle.aspnetcore.swaggergen, который является генератором чванства, который создает объекты SwaggerDocument непосредственно из ваших маршрутов, контроллеров и моделей; и swashbuckle.aspnetcore.swaggerui, который является встроенной версией инструмента пользовательского интерфейса Swagger. Он интерпретирует Swagger Json, чтобы создать богатый, настраиваемый опыт для описания функциональности веб -API. Swagger (OpenAPI)-это языковая реактивная спецификация для описания API REST. Это позволяет как компьютерам, так и людям понимать возможности API REST без прямого доступа к исходному коду. Его основные цели - минимизировать объем работы, необходимой для подключения отдельных услуг. ¹³⁴
Этот учебник и демонстрационный проект покажут, как настроить, настроить и кодировать простой HTTPClient для проекта Contoso Pizza Web API.
В этом видео на YouTube мы узнаем, как создать простой проект приложения консоли, который подключается к веб -API и проверяет его. Видео включает в себя короткую демонстрацию проекта, работающего и вывода результатов API. Мы получим файл OpenAPI, сначала запустив наш WebAPI локально, чтобы показать пользовательский интерфейс Swagger. Файл JSON для нашего веб -API может быть загружен и сохранен в нашем каталоге проекта. В серии Playlist есть еще одно видео, которое показывает, как настроить и настроить документацию Swagger. Следующим шагом является добавление нового проекта приложения консоли в наше решение. Это будет приложение HTTPClient для подключения к нашему веб -API. Далее мы добавим ссылку на услуги OpenAPI из файла JSON UI Swagger, который мы ранее сохранили. Visual Studio будет автоматически генерировать класс клиентского кода, необходимый для взаимодействия с веб-API Contoso Pizza. Мы посмотрим на класс сгенерированного кода. Конструктор нуждается как экземпляр объекта HTTPClient, так и базовый URL -адрес работает веб -API. Если вы запускаете свой веб -API на локальном уровне, вы можете найти это из профиля запуска отладки. Наконец, мы можем кодировать наш проект, чтобы создать HTTPClient и Service Service Service для веб -API Pizza UI Contoso и попытаться получить пиццу. Убедитесь, что приложение Web API уже работает локально перед запуском приложения консоли HTTPClient.
Этот учебник и демонстрационный проект покажет, как настроить, настраивать и кодировать простые модульные тесты для проекта WebAPI.
В этом видео мы обсудим, как написать простые модульные тесты для веб -API с операциями CRUD Controller. Мы будем использовать пакеты XUNIT и FAKEITEASY для написания тестов. Мы рассмотрим основы модульного тестирования, в том числе «Как настроить тестовый проект», «Как писать тесты для каждой операции CRUD», и как использовать XUNIT и FAKEITEASY для создания макетов и заглушек. Мы также обсудим передовые практики для написания модульных тестов, таких как сохраняние независимых тестов и обеспечение того, чтобы их было легко читать и поддерживать.
Хотя были ссылаются учебные пособия, видео и документация, этот проект творчески мой собственный код и стиль, чтобы продемонстрировать мой технический опыт и внести свой вклад в коллективные технологические знания на GitHub. Я перечислил некоторые из источников, где я нарисовал некоторые примеры кода и знания.
Серия новичков к: веб -APIS
Microsoft Learn - Создайте веб -API с помощью Core Controllers ASP.NET
Источник: Разговор с Bing, 10.11.2023 (1) Начните с Swashbuckle и Asp.net Core. https: //learn.microsoft.com/en-us/asp .... (2) документация ASP.NET Core Web API с Swagger/OpenAPI. https: //learn.microsoft.com/en-us/asp .... (3) Что такое Swagger, Swashbuckle и Swashbuckle UI. https: //stackoverflow.com/questions/4 .... (4) улучшить опыт разработчика API с документацией Swagger .... https: //learn.microsoft.com/en-us/tra ...
JsonPatch в ASP.net Core Web API
