MyWebAPITemplate

Template API web saya

Templat pemula untuk semua jenis API REST dengan ASP.NET Core

Ini adalah pekerjaan saya, terus -menerus bekerja, templat starter, untuk membangun API istirahat.

Template ini untuk Anda jika Anda hanya ingin memulai dengan pengkodean, menginginkan struktur proyek yang sudah dipikirkan, itu cukup sederhana dan cepat untuk dipelajari, dan bekerja pada proyek yang lebih kecil dan lebih besar dengan baik.

Detail

Teknologi, kerangka kerja dan perpustakaan

• Bahasa Pemrograman: C#
• Kerangka kerja: ASP.NET Core 7 (selalu versi terbaru)
• Database: SQL Server (juga mungkin untuk menggunakan database lain)
• ORM: Kerangka kerja entitas
• Pengujian: Xunit, MOQ & FLUENTASSERTIONS

Arsitektur, fitur, dan pola

• Aplikasi proses tunggal (monolitik)
• Arsitektur Bersih/Bawang
• Mengikuti prinsip API istirahat yang paling umum
• Struktur kode yang menangani kasus penggunaan yang paling khas dengan penskalaan dalam pikiran
• Swagger/Openapi dengan UI
• Konfigurasi Pengembangan/QA/Produksi
• Penyemaian database
• Penanganan kesalahan global
• Pemetaan Model
• Validasi
• Tes Komprehensif (Fungsional, Integrasi, dan Uji Unit)
• Logging
• Pola repositori
• Dukungan Docker
• ..dan lebih banyak di backlog

Struktur folder template

 app                               -> App and related files
 ├─> src                          -> App source
 │   ├─> Web                      -> Entry point for API - runnable project
 │   │   ├─> Controllers          -> API endpoints
 │   │   ├─> Extensions           -> Extension methods
 │   │   ├─> Interfaces           -> Web project's interfaces
 │   │   ├─> Mappers              -> Model mappers
 │   │   ├─> Middlewares          -> Middlewares (e.g. global error handling)
 │   │   |─> Models               -> Models in and out of API
 │   │   ├─> Settings             -> Options pattern for App (e.g. connection strings)
 │   │   ├─> Validators           -> Model validation rules
 │   │   ├── Program.cs           -> START
 │   │   └── Startup.cs           -> START
 │   ├─> Core                     -> Holds business logic
 │   │   ├─> Dtos                 -> Data-transfer-object (used for business logic)
 │   │   ├─> Entities             -> Entity Framework entities for database 
 │   │   ├─> Interfaces           -> Core project's interfaces
 │   │   ├─> Mappers              -> Dto and Entity mappers
 │   │   ├─> Services             -> Business logic services
 │   └─> Infrastructure           -> Data access and external services 
 │       ├─> Database             -> Database access
 │       │   ├─> Configurations   -> Entity Framework table configurations
 │       │   ├─> Migrations       -> Entity Framework autogenerated migrations
 │       │   ├─> Repositories     -> Repository pattern
 │       │   ├── AppDbContext.cs  -> Base context
 │       │   ├── AppSeed.cs       -> Database seeding
 │       │   └── EfRepository.cs  -> Base repository
 │       └─> ExternalServices     -> Services that access external services (e.g. ext. email service)
 └─> tests                        -> App tests
     ├── FunctionalTests          -> Endpoint tests etc.
     │   ├─> Tests                -> All tests
     │   └─> Utils                -> Utility functions (e.g. test database setup)
     ├── IntegrationTests         -> Database tests etc.
     │   ├─> Tests                -> All tests
     │   ├─> Utils                -> Utilities functions (e.g. test database setup)
     ├── UnitTests                -> Application logic tests etc.  
     │   ├─> Tests                -> All tests
     │   ├─> Utils                -> Utility functions 
     └── Shared                   -> Model builders and other shared functions for tests

Penggunaan

Di windows

1. Unduh .NET SDK Terbaru (https://dotnet.microsoft.com/download)
2. Saat menjalankan pertama kali - inisialisasi database

   •  dotnet tool install --global dotnet-ef
     dotnet ef database update -c ApplicationDbContext -p . /src/Infrastructure/Infrastructure.csproj -s . /src/Web/Web.csproj

3. Meluncurkan
   • Opsi 1. Peluncuran di Visual Studio
     1. Buka dengan MyWebAPITemplate.sln
     2. Tekan F5 atau Debug/Start Debugging
   • Opsi 2. Peluncuran di CLI

     1.  dotnet run -p . /src/Web/

4. Arahkan ke https: // localhost: 5001/Swagger/index.html

Cross-Platform dengan Docker (sedang berlangsung)

1. Saat ini hanya mungkin dengan dalam memori

Migrasi basis data baru

Ketika Anda perlu membuat migrasi baru (ketika Anda mengubah skema database), kemudian jalankan perintah ini untuk memberi tahu kerangka kerja entitas untuk menangani perubahan skema yang diperlukan untuk database.

 dotnet ef migrations add NewMigrationNameHere --context ApplicationDbContext -p . /src/Infrastructure/Infrastructure.csproj -s . /src/Web/Web.csproj -o Database /Migrations 

Motivasi

Proyek ini dimulai sebagai cara saya untuk menangani aliran informasi dari segala sesuatu yang perlu dilakukan saat membangun API dengan cara monolitik tunggal. Ada begitu banyak hal yang perlu diingat dan ada banyak pilihan yang harus dibuat. Oleh karena itu, saya membuat templat ini, untuk diri saya sendiri, untuk menyimpan semua praktik yang saya temukan praktis dan saya berharap template ini juga dapat membantu orang lain belajar satu atau dua hal.

Dalam templat ini, saya telah mengumpulkan pengetahuan saya tentang bangunan API dalam format praktis. Preferensi arsitektur, pilihan perpustakaan, dan pilihan lain dibuat, berdasarkan praktik terbaik, popularitas dan preferensi saya sendiri. Tujuan dari template ini, adalah untuk memberikan contoh dasar yang baik tentang cara membangun API REST dengan ASP.NET yang dapat diskalakan, mudah diangkat dan berisi konfigurasi yang diperlukan dan barang lainnya. Template ini terinspirasi oleh aplikasi referensi Microsoft EshoponWeb dan banyak lainnya.

Sasaran

• Untuk meningkatkan template setiap kali saya menemukan sesuatu yang bermanfaat, atau saya menghasilkan cara baru yang lebih baik untuk menangani beberapa bagian dari program.
• Untuk hanya menggunakan konsep atau teknologi yang telah saya gunakan dalam beberapa proyek saya sebelumnya, jadi saya tahu jika itu sepadan. Proyek ini bukan untuk mengutak -atik semua hal eksperimental, ada proyek lain untuk itu :)
• Untuk menjaga strukturnya tetap sederhana, tetapi tidak terlalu sederhana. Struktur proyek ini mungkin tampak agak berlebihan untuk aplikasi TODO, tetapi strukturnya ada di sini untuk menunjukkan satu cara untuk menangani struktur kode pada proyek yang lebih besar. Struktur kode harus dapat menangani sistem yang lebih besar dengan jumlah kode dan fitur yang lebih besar.
• Untuk menjaga template sebagai "monolitik", karena saya pikir ini mungkin cara terbaik untuk memulai proyek baru. Baca lebih lanjut di sini
• Untuk didapat, tetapi saya selalu berpikir untuk siap mengubah apa pun jika ada cara yang lebih baik untuk melakukan

Berkontribusi dan lisensi

Proyek ini berlisensi MIT - jadi jangan ragu untuk menggunakannya. Saran dan bantuan disambut. ?