aspnet api

ASPNET-API

最小限のASP.NETコアAPI

要件

• .NET 8.0 SDK
• MySQLデータベース

特徴

• Openapi
• 依存関係噴射コンテナ（自動操作付き）
• 単一のアクションコントローラー、サービス、リポジトリ
• 環境固有の構成
• 12ファクター.env構成ローダー（機密データ用）
• MySQLデータベース接続
• sql querybuilder（sqlkata）
• データベーストランザクション処理
• 入力検証（FluentValidation）
• ValidationExceptionミドルウェア
• ローカリゼーション（ngetText）
• コンテキスト固有のロギング（Serilog）
• ファイルベースのエラーログ
• GitHubアクションを使用した継続的統合（CI）ワークフロー
• データベース移行（DBUP）

テスト

• Xunitテスト
• HTTPエンドポイントテスト（テストデータベースを使用）
• ログメッセージの流fluentアサーション

トト

• データベーステストのための流fluentアサーション
• 認証（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を開き、Project 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

ライセンス

MITライセンス（MIT）。詳細については、ライセンスファイルをご覧ください。