aspnet api

Aspnet-api

最小ASP.NET核心API

要求

• .NET 8.0 SDK
• 一個MySQL數據庫

特徵

• Openapi
• 依賴注入容器（自動引導）
• 單個動作控制器，服務和存儲庫
• 特定環境配置
• 12因子.env配置加載器（敏感數據）
• MySQL數據庫連接
• SQL QueryBuilder（SQLKATA）
• 數據庫交易處理
• 輸入驗證（Fulentvalidation）
• 驗證Exception中間件
• 本地化（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; 

相應地修改數據庫名稱。

在MyApi目錄中創建.env文件：

 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並在項目Resources目錄中創建一個新的PO翻譯文件。
• 文件名必須與文化名稱相同，例如de-DE.po 。
• 打開菜單Translations > Settings
• 更改PO語言，例如German
• 添加_localizer.GetString作為源關鍵字。
• 使用您的項目CS文件添加源路徑。
• 保存文件，然後單擊Update from source以解析新的翻譯。
• 翻譯消息並保存文件以生成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標頭值來檢測用戶語言。如果此標頭包含有效的代碼，則將自動切換當前文化。

測試

為Xunit創建本地測試數據庫。

 CREATE DATABASE ` my_api_test ` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci; 

在MyApi.Tests目錄中創建.env文件：

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

相應地修改數據庫和憑據。

要啟動測試套件，請運行：

 dotnet test

執照

麻省理工學院許可證（麻省理工學院）。請參閱許可證文件以獲取更多信息。