aspnet api

aspnet-api

ASP.NET CORE API น้อยที่สุด

ความต้องการ

• .NET 8.0 SDK
• ฐานข้อมูล mysql

คุณสมบัติ

• Openapi
• ภาชนะฉีดพึ่งพา
• ตัวควบคุมแอ็คชั่นเดียวบริการและที่เก็บ
• การกำหนดค่าเฉพาะสภาพแวดล้อม
• ตัวโหลดการกำหนดค่า 12-factor .env (สำหรับข้อมูลที่ละเอียดอ่อน)
• การเชื่อมต่อฐานข้อมูล MySQL
• SQL QueryBuilder (SQLKATA)
• การจัดการธุรกรรมฐานข้อมูล
• การตรวจสอบความถูกต้องของอินพุต (FluentValidation)
• ValidationException Middleware
• การแปล (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 เป็นคำหลักแหล่งที่มา
• เพิ่มเส้นทางต้นทางด้วยไฟล์ Project CS ของคุณ
• บันทึกไฟล์และคลิก Update from source เพื่อแยกวิเคราะห์สำหรับการแปลใหม่
• แปลข้อความและบันทึกไฟล์เพื่อสร้างไฟล์ MO เช่น de-DE.mo

การเปลี่ยนภาษา

คุณสามารถเปลี่ยนภาษาในระหว่างการร้องขอโดยการตั้งค่า CurrentCulture ดังนี้:

 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

แก้ไขฐานข้อมูลและข้อมูลรับรองตามนั้น

ในการเริ่มชุดทดสอบ Run:

 dotnet test

ใบอนุญาต

ใบอนุญาต MIT (MIT) โปรดดูไฟล์ใบอนุญาตสำหรับข้อมูลเพิ่มเติม