aspnet api

Aspnet-Api

Минимальный API ASP.NET CORE API

Требования

• .NET 8.0 SDK
• База данных MySQL

Функции

• Openapi
• Контейнер впрыскивания зависимостей (с автоматическим проведением)
• Контроллеры, услуги и репозитории единого действия
• Специальная конфигурация среды
• 12-фактор .env
• MySQL Batabase Connection
• SQL QueryBuilder (SQLKATA)
• Обработка транзакций базы данных
• Входная проверка (FluentValidation)
• ValidationException промежуточное программное обеспечение
• Локализация (NGETTEXT)
• Контекст специфичный журнал (Serilog)
• Файловая ошибка журнала ошибок
• Рабочий процесс непрерывной интеграции (CI) с действиями GitHub
• Миграции базы данных (DBUP)

Тестирование

• Тесты XUNIT
• HTTP -тесты конечных точек (с использованием тестовой базы данных)
• Свободно утверждения сообщений журнала

Тодо

• Свободные утверждения для тестов базы данных
• Аутентификация (Basicauth)
• Строительный сценарий

Установка

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

 git clone https://github.com/odan/aspnet-api.git --depth 1 {my-app-name}
cd {my-app-name}

Замените {my-app-name} на желаемое имя для вашего проекта.

Создайте новую базу данных MySQL / MariaDB.

 CREATE DATABASE ` my_api ` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; 

Соответственно изменить имя базы данных.

Создайте файл .env в каталоге MyApi :

 MYSQL_HOST = localhost
MYSQL_PORT = 3306
MYSQL_USER = root
MYSQL_PASSWORD =
MYSQL_DATABASE = my_api

Соответственно измените базу данных и учетные данные.

Импортируйте файл schema.sql вручную или запустите следующую команду:

 npm run migration:migrate

Примечание: эта команда требует NPM.

Команды

Чтобы создать и запустить приложение в режиме отладки, запустите:

 dotnet run

или

 dotnet watch run

Запуск сборки релиза:

 dotnet run --configuration Release

Создайте проект и его зависимости:

 dotnet build

Создание проекта и его зависимостей с использованием конфигурации выпуска:

 dotnet build --configuration Release

Очистка каталогов корзины и OBJ:

 dotnet clean

Чистить и построить:

 dotnet rebuild

Публиковать:

 dotnet publish

Стили кода

Установите пакет dotnet-format :

 dotnet tool install --global dotnet-format 

Проверка стилей кода:

 dotnet format --verify-no-changes

Исправление стилей кода:

 dotnet format -v d

Переводы

Объявите интерфейс IStringLocalizer<T> , где вам нужно перевести сообщения.

Пример

 public class Example
{
    private readonly IStringLocalizer < Example > _localizer ;

    public Example ( IStringLocalizer < Example > localizer )
    {
        _localizer = localizer ;
    }

    // ...
}

Использование перевода

По умолчанию и исходному языку английский.

Перевод простого сообщения:

 string text = _localizer . GetString ( "Hello, World!" ) ;

// Output: Hallo, Welt!

Перевод сообщения с заполнителем (ы):

 string text2 = _localizer . GetString ( "The user {0} logged in" , "sally" ) ;

// Output: Der Benutzer sally hat sich eingeloggt

Создание нового файла перевода

• Откройте POEDIT и создайте новый файл перевода PO в каталоге Resources проекта.
• Имя файла должно быть таким же, как и название культуры, например de-DE.po
• Откройте Translations меню> Settings
• Изменить язык PO, например German
• Добавить _localizer.GetString в качестве ключевого слова источников.
• Добавьте исходные пути с помощью файлов CS вашего проекта.
• Сохраните файл и нажмите Update from source в Parse для новых переводов.
• Переведите сообщения и сохраните файл для генерации файла MO, например, de-DE.mo .

Изменение языка

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

 using using System . Globalization ;
// ...

var culture = new CultureInfo ( "de-DE" ) ;
Thread . CurrentThread . CurrentCulture = culture ;
Thread . CurrentThread . CurrentUICulture = culture ;

LocalizationMiddleware обнаруживает язык пользователя, используя значение заголовка HTTP Accept-Language запроса. Если этот заголовок содержит действительный код, CurrentCulture будет автоматически переключаться.

Тестирование

Создайте локальную тестовую базу данных для XUNIT.

 CREATE DATABASE ` my_api_test ` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; 

Создайте файл .env в каталоге MyApi.Tests :

 MYSQL_HOST = localhost
MYSQL_PORT = 3306
MYSQL_USER = root
MYSQL_PASSWORD =
MYSQL_DATABASE = my_api_test

Соответственно измените базу данных и учетные данные.

Чтобы начать тестовый набор, запустите:

 dotnet test

Лицензия

Лицензия MIT (MIT). Пожалуйста, смотрите файл лицензии для получения дополнительной информации.