dotnet7 template webapi full

dotnet7 template webapi full

Kategori lainnya

1.0.0

Unduh

Implementasi Lengkap API Web

Ini adalah templat yang dimaksudkan untuk mengatur aplikasi API Web yang diimplementasikan sepenuhnya menggunakan .NET 7 .

Daftar isi

Apa yang diharapkan
Teknologi
Penggunaan
Tukar DBMS
Peran pengguna
Validator Kredensial Pengguna
Uninstall
Lisensi

Apa yang diharapkan

Log yang sepenuhnya dapat disesuaikan dan otomatis yang mengubah file pada interval harian untuk keterbacaan.
Edit nilai di file appsettings.json untuk dipersonalisasi.
- Rute dipanggil
- Tindakan pengguna
- Pengecualian (dengan ID pengecualian unik untuk debugging yang lebih mudah)
- Langkah Pengaturan Server
Layanan versi
Validasi Kredensial Pengguna
- Validasi kata sandi yang dapat disesuaikan
  Edit nilai di file appsettings.json untuk dipersonalisasi.
- Validasi email
- Validasi Nama Pengguna
Otentikasi JWT
- Pembuatan Pengguna
- Login dan Sesi
- Enkripsi Kata Sandi
- Layanan publik maupun yang terotentikasi
Otorisasi Berbasis Peran
- Akun Admin dan Anggota
- Layanan admin saja
- Akun Pengguna Admin Default
  Edit nilai di file appsettings.json untuk dipersonalisasi.
Siap basis data
- SQLite sudah diatur
- Mudah bertukar DBMS

⬆ Kembali ke Daftar Isi

Teknologi

.Net 7
Inti ASP.NET
Bcrypt
Kerangka kerja entitas
Jwt
Serilog
Sqlite
Menyombongkan

⬆ Kembali ke Daftar Isi

Penggunaan

Klon Repositori
Buka Terminal ke Folder Template
```
 cd webapi-full
```
Instal template yang akan digunakan untuk pembuatan proyek
- Untuk windows
```
dotnet new install .
```
- Untuk macOS / linux
```
dotnet new install ./
```
Anda mungkin perlu menghapus satu versi untuk menginstal versi yang diperbarui.
Untuk menghindari ketidaknyamanan ini, cukup tambahkan opsi --force pada perintah di atas.
Buat proyek
```
dotnet new webapi-full
```
Ingatlah untuk menjalankan perintah ini ke direktori kosong karena akan digunakan sebagai folder proyek.
Beri nama direktori yang Anda suka, namespace proyek akan mewarisi nama itu.
Tambahkan migrasi dan buat database
```
dotnet ef migrations add CreateUser
```
Dan
```
dotnet ef database update
```
Jika Anda tidak menginstal kerangka kerja entitas, jalankan yang berikut:
```
dotnet tool install --global dotnet-ef
```
Jalankan proyek dan cobalah menggunakan kesombongan
```
dotnet watch run
```

⬆ Kembali ke Daftar Isi

Tukar DBMS

Ada 2 sistem manajemen basis data yang akan saya sertakan.

SQL Server
PostgreSQL

Tentu saja, ada lebih banyak tetapi ini adalah yang paling banyak bekerja dengan saya.
Untuk lebih banyak penyedia data , kunjungi dokumentasi EF Core Resmi.

SQL Server

Instal Paket Konektor Entity Framework.

dotnet add package Microsoft.EntityFrameworkCore.SqlServer

Ubah string koneksi di appsettings.json menjadi sesuatu seperti ini:

{
  "ConnectionStrings" : {
    "Demo" : " Server=<SERVER_NAME>;Database=<DATABASE_NAME>;Trusted_Connection=true;MultipleActiveResultSets=true;Trust Server Certificate=true "
  },
  ...
}

Ubah Layanan ApplicationDbContext Anda untuk menggunakan SQL Server .

Ini dilakukan di dalam program.cs .

 builder . Services . AddDbContext < ApplicationDbContext > ( options => 
  options . UseSqlServer ( builder . Configuration . GetConnectionString ( "Demo" ) )
) ;

PostgreSQL

Instal Paket Konektor Entity Framework.

dotnet add package Npgsql.EntityFrameworkCore.PostgreSQL

Ubah string koneksi di appsettings.json menjadi sesuatu seperti ini:

{
  "ConnectionStrings" : {
    "Demo" : " Host=localhost:5432;Database=<DATABASE>;Username=<USERNAME> "
  },
  ...
}

Ubah Layanan ApplicationDbContext Anda untuk menggunakan PostgreSQL .

Ini dilakukan di dalam program.cs .

 builder . Services . AddDbContext < ApplicationDbContext > ( options => 
  options . UseNpgsql ( builder . Configuration . GetConnectionString ( "Demo" ) )
) ;

PostgreSQL membutuhkan beberapa langkah tambahan untuk menjalankan solusi ini.

Ubah properti Is_Deleted dari Class IndexedObject karena DBMS ini tidak mendukung tipe bit .

 [ Required ]
[ Column ( "Is_Deleted" ) ]
[ JsonIgnore ]
public bool IsDeleted { get ; set ; } = false ;

Tambahkan Program Inside berikut ini tepat setelah Kode Langkah 3.

 AppContext . SetSwitch ( "Npgsql.EnableLegacyTimestampBehavior" , true ) ;
AppContext . SetSwitch ( "Npgsql.DisableDateTimeInfinityConversions" , true ) ;

Ini penting bagi Postgre untuk mendukung properti DateTime kami.

⬆ Kembali ke Daftar Isi

Peran pengguna

Menyatakan peran

Peran pengguna didefinisikan di 2 tempat agar aplikasi berfungsi:

Role enum
Enum ini memiliki peran aplikasi yang tersedia serta indeks masing -masing peran.
Indeks ini penting untuk fungsionalitas aplikasi dan berfungsi secara sederhana: semakin tinggi indeks, semakin istimewa peran tersebut.
Enum default memegang nilai -nilai berikut:
```
{
  "User" : 1 ,
  "Admin" : 2
}
```
Perhatikan bahwa admin memiliki indeks yang lebih tinggi karena itu adalah peran yang unggul.

Di dalam program.cs untuk menerjemahkan nilai -nilai enum menjadi " kebijakan " yang digunakan oleh aplikasi.

 builder . Services . AddAuthorization ( options =>
{
    options . AddPolicy ( "admin" , policy => policy . Requirements . Add ( new RoleRequirement ( Role . Admin ) ) ) ;
    options . AddPolicy ( "user" , policy => policy . Requirements . Add ( new RoleRequirement ( Role . User ) ) ) ;
} ) ;

Setelah menambahkan peran ke enum, wajib juga menambahkannya di sini.

Layanan yang diotentikasi pengguna

Untuk mengotentikasi layanan apa pun untuk pengguna, sederhana tambahkan atribut [Authorize] .

Penting bahwa peran tersebut dinyatakan juga agar otorisasi bekerja.

 [ Authorize ( Policy = "user" ) ]
[ HttpGet ]
public IActionResult GetLoggedUser ( )
{
    User user = this . userUtils . GetLoggedUser ( this . User ) ;

    Log . Information ( $ "Retrieved user ' { user . UserName } '." ) ;

    return Ok ( user ) ;
}

Ini adalah layanan yang dapat digunakan oleh pengguna mana pun.
Ingatlah bahwa itu masih bukan layanan publik dan Anda harus masuk untuk menggunakannya. Hanya saja tidak ada peran khusus yang diperlukan.

Akun Administrator Default

Di dalam appsettings.json , ada kredensial administrator default dan informasi penting.

Aplikasi menggunakan informasi ini untuk secara otomatis membuat pengguna pada pembuatan database.

Data dinyatakan dalam bentuk JSON berikut:

 "DefaultAdmin" : {
  "Email" : " [email protected] " ,
  "UserName" : " admin_user " ,
  "FirstName" : " Admin " ,
  "LastName" : " User " ,
  "Password" : " 123 "
}

Dianjurkan agar Anda mengubah setidaknya email dan kata sandi sebelum melanjutkan.

⬆ Kembali ke Daftar Isi

Validator Kredensial Pengguna

Nama belakang

Validasi nama pengguna sederhana tetapi opini.

Nama pengguna:

Tidak boleh menyertakan karakter whitespace .
Harus memiliki panjang maksimum 40 karakter.
Harus memiliki panjang minimum 6 karakter.
Hanya mengizinkan karakter non-alfanumerik tertentu:
- _
- -
Tidak dapat memiliki huruf besar.

Untuk mengembalikan seluruh daftar aturan dan tandai yang tidak valid, pesan yang diformat dikembalikan sebagai tag HTML <ul></ul> .

Lebih khusus lagi, berikut adalah contoh validasi yang gagal:

 < ul class =' username-validation ' >
  < li class =' valid ' > Username cannot contain whitespaces. </ li >
  < li class =' invalid ' > Username cannot exceed 40 characters. </ li >
  < li class =' valid ' > Username must be at least 6 characters long. </ li >
  < li class =' valid ' > The only allowed special characters are the following: -, _ </ li >
  < li class =' valid ' > Username must be lowercase. </ li >
</ ul >

Untuk mengedit validator ini, Anda harus mengedit kode karena aturannya hardcoded. Ini terjadi karena validasi nama pengguna mengikuti standar.
Dalam contoh di atas, semua validator lulus kecuali untuk yang menegakkan panjang maksimum 40 karakter.

E-mail

Validasi email cukup mudah.

Semua alamat yang disediakan oleh pengguna valid selama mereka tetap pada format.

Saya tidak melihat gunanya mengubah validator ini tetapi Anda bebas melakukannya dalam kode Anda.

Metode ValidateEmail dan ValidateUserName didefinisikan sebagai bagian dari antarmuka IUserUtils .

Kata sandi

Validasi kata sandi adalah yang paling kompleks dan mudah disesuaikan sehingga aturannya didefinisikan dalam file appsettings.json .

Pada generasi aplikasi, Anda akan menemukan bagian ini dalam file yang disebutkan sebelumnya:

 "PasswordValidator" : {
  "AllowedNonAlphanumeric" : " !@#$._- " ,
  "MaxLength" : 16 ,
  "MinLength" : 8 ,
  "RequireDigit" : false ,
  "RequireLowercase" : true ,
  "RequireNonAlphanumeric" : true ,
  "RequireUppercase" : true
},

Apa yang dilakukannya adalah:

Diizinkan non-alfanumerik
Aturan ini menetapkan karakter non-alfanumerik yang diizinkan yang diizinkan oleh kata sandi.
Karakter tidak boleh dipisahkan oleh apa pun. Taruh saja semuanya di string JSON.
Untuk tidak mengizinkan non-alfanumerik, buat nilainya string kosong.
Panjang maksimal
Panjang maksimal melakukan apa yang disiratkan namanya.
Jika Anda mengaturnya ke angka, string kata sandi tidak dapat melebihi banyak karakter yang panjangnya.
Untuk berhenti menegakkan panjang maksimum untuk kata sandi, atur nilainya ke 0.
Panjang min
Bekerja seperti rekan panjang maksimumnya.
Kata sandi tidak dapat memiliki karakter yang lebih sedikit daripada angka yang ditetapkan untuk bidang ini.
Untuk berhenti menegakkan panjang minimum untuk kata sandi, atur nilainya ke 0.
Membutuhkan digit
Ini adalah variabel Boolean .
Jika diatur ke True, pengguna harus menggunakan setidaknya 1 digit ( [0-9] ) untuk kata sandi mereka.
Untuk tidak menegakkan aturan ini, atur nilainya menjadi false .
Membutuhkan huruf kecil
Ini adalah variabel Boolean .
Jika diatur ke True, pengguna harus menggunakan setidaknya 1 huruf kecil untuk kata sandi mereka.
Untuk tidak menegakkan aturan ini, atur nilainya menjadi false .
Membutuhkan non-alfanumerik
Ini adalah variabel Boolean .
Jika diatur ke True, pengguna harus menggunakan setidaknya 1 dari karakter non-alfanumerik yang diizinkan untuk kata sandi mereka.
Untuk tidak menegakkan aturan ini, atur nilainya menjadi false .
Membutuhkan huruf besar
Ini adalah variabel Boolean .
Jika diatur ke True, pengguna harus menggunakan setidaknya 1 huruf besar untuk kata sandi mereka.
Untuk tidak menegakkan aturan ini, atur nilainya menjadi false .
Juga, secara default, kata sandi tidak dapat berisi karakter spasi putih.

Untuk mengembalikan seluruh daftar aturan dan tandai yang tidak valid, pesan yang diformat dikembalikan sebagai tag HTML <ul></ul> .

Lebih khusus lagi, berikut adalah contoh validasi yang gagal:

 < ul class =' password-validation ' >
  < li class =' valid ' > Password cannot contain whitespaces. </ li >
  < li class =' invalid ' > The only allowed special characters are the following: !, @, #, $, ., _, - </ li >
  < li class =' valid ' > Password cannot exceed 16 characters. </ li >
  < li class =' invalid ' > Password must be at least 8 characters long. </ li >
  < li class =' valid ' > Password must contain at least one digit. </ li >
  < li class =' valid ' > Password must contain at least one lowercase letter. </ li >
</ ul >

Dalam contoh di atas, kata sandi hampir valid tetapi itu:
berisi karakter non-alfanumerik yang tidak diizinkan dan
terlalu pendek.

Untuk mengedit validasi kata sandi, Anda (mungkin) harus melakukan 3 hal:

Edit aturan di dalam file appsettings.json .
Edit kelas PasswordValidator untuk mencocokkan aturan tersebut.
Jika Anda hanya mengubah nilai -nilai aturan yang ada, tidak perlu untuk itu.
Edit logika validasi yang dinyatakan sebagai bagian dari antarmuka IPasswordUtils di dalam kelas implementasi yang disediakan atau dengan membuat sendiri.
Jika Anda hanya mengubah nilai -nilai aturan yang ada, tidak perlu untuk itu.

⬆ Kembali ke Daftar Isi

Uninstall

Untuk menghapus instalan templat, cukup lakukan hal berikut:

Buka Terminal ke Folder Template
```
 cd webapi-full
```
Hapus instalan templat dengan menjalankan:
- Untuk windows
```
dotnet new uninstall .
```
- Untuk macOS / linux
```
dotnet new uninstall ./
```

⬆ Kembali ke Daftar Isi