aspnet api

aspnet-api

الحد الأدنى من ASP.NET Core API

متطلبات

• .NET 8.0 SDK
• قاعدة بيانات MySQL

سمات

• Openapi
• حاوية حقن التبعية (مع التلقائي)
• وحدات تحكم العمل الفردية والخدمات والمستودعات
• التكوين المحدد للبيئة
• محمل تكوين 12 عامل .env (للبيانات الحساسة)
• اتصال قاعدة بيانات MySQL
• SQL QueryBuilder (Sqlkata)
• معاملة معاملات قاعدة البيانات
• التحقق من صحة المدخلات (FluentValidation)
• ValidentException الوسيطة
• توطين (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 Project.
• احفظ الملف وانقر فوق 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 لغة المستخدم باستخدام قيمة رأس Accept-Language طلب HTTP. إذا كان هذا الرأس يحتوي على رمز صالح ، فسيتم تبديل الثقافة الحالية تلقائيًا.

الاختبار

إنشاء قاعدة بيانات اختبار محلية لـ 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). يرجى الاطلاع على ملف الترخيص لمزيد من المعلومات.