ProWebAPI

В этом документе подробно описана реализация надежного и стандартизированного API ASP.NET Core с использованием ProWebAPI. Он охватывает такие ключевые аспекты, как интеграция Swagger, внедрение зависимостей, стандартизированные ответы, управление версиями, проверка запросов, поддержка OData v4, глобальная обработка исключений и EF Core с UnitOfWork. Руководство содержит пошаговые инструкции для каждого компонента.

ПроВебAPI

ASP.NET Core API со всеми надлежащими стандартами.

Стандарты реализованы

Суэггер

Установить Сваггер

Настройка цифрового ввода-вывода

Стандартный ответ для API

Стандартный ответ

Управление версиями

Установить библиотеку Nuget

Добавить в контейнер зависимостей

Украсьте базу контроллеров по мере необходимости

Запросить валидатор

Установить библиотеку Nuget

Регистрация валидаторов на DI

В пространстве имен RequestDto добавьте валидаторы вместе с dto.

Создайте фильтр проверки

Зарегистрируйте фильтр и отключите [ApiController] автоматический перехват 400 Bad Request.

AppSettings.json

Настройка параметров приложений для баз данных

Создайте 2 конфигурации СРЕДЫ.

Одата v4

Для поддержки OData установите пакеты NuGet.

Добавить в сервис DI для OData

Настройка OData

Переопределить атрибут [EnableQuery] с помощью [EnableOData], чтобы перехватывать ошибки и возвращать стандартный ответ.

Украсьте метод действия

Запрос по URL

Глобальный обработчик исключений

Создайте промежуточное программное обеспечение

Создайте метод расширения для конструктора приложений.

Зарегистрируйте промежуточное программное обеспечение

Корпус ответа

Разрешить регистр элементов (который будет в регистре Паскаля для реквизитов), чтобы результат запроса OData не конфликтовал с регистром.

EF Core + UnitOfWork

Добавить поддерживающие библиотеки классов

Установите необходимые пакеты на ProWeb.Data.

Запуск миграции

УСТАНОВИТЕ ProWeb.Data как [Стартап-проект] и запустите миграцию.