JsonApiDotNetCore

Jsonapidotnetcore

Kerangka kerja untuk membangun JSON: API REST yang sesuai dengan API menggunakan inti .NET Core dan Entity Framework. Termasuk dukungan untuk operasi atom.

Tujuan akhir dari perpustakaan ini adalah untuk menghilangkan sebanyak mungkin boilerplate dengan menawarkan fitur out-of-the-box seperti penyortiran, penyaringan, dan pagination. Anda hanya perlu fokus pada mendefinisikan sumber daya dan mengimplementasikan logika bisnis khusus Anda. Perpustakaan ini telah dirancang di sekitar injeksi ketergantungan, membuat ekstensibilitas sangat mudah.

Memulai

Ini adalah beberapa langkah yang dapat Anda ambil untuk membantu Anda memahami apa proyek ini dan bagaimana Anda dapat menggunakannya:

Tentang

• Apa itu JSON: API dan mengapa saya harus menggunakannya? (Blog, 2017)
• JSON Pragmatis: Desain API (Video, 2017)
• JSON: API dan JSONAPIDOTNETCORE (Video, 2021)
• Rilis JSONAPIDOTNETCORE 4.0 (Blog, 2020)
• JSON: API, .NET Core, Emberjs (Video, 2017)
• Embercasts: Full Stack Ember dengan ASP.NET Core (Kursus berbayar, 2017)

Dokumentasi resmi

• Spesifikasi JSON: API
• Situs web JsonapidotNetCore
• Peta jalan

Proyek terkait

• Laporan Kinerja
• Jsonapidotnetcore.mongodb
• Aplikasi daftar TODO EMBER.JS

Contoh

Lihat Direktori Contoh untuk aplikasi sampel terkini. Ada juga aplikasi daftar TODO yang menyertakan API JsonapidotNetCore dan klien Emberjs.

Instalasi dan penggunaan

Lihat dokumentasi kami untuk penggunaan terperinci.

Model

#nullable enable

[ Resource ]
public class Article : Identifiable < int >
{
    [ Attr ]
    public string Name { get ; set ; } = null ! ;
}

Middleware

 // Program.cs

builder . Services . AddJsonApi < AppDbContext > ( ) ;

// ...

app . UseRouting ( ) ;
app . UseJsonApi ( ) ;
app . MapControllers ( ) ; 

Kesesuaian

Bagan berikut akan membantu Anda memilih versi terbaik, berdasarkan lingkungan Anda. Lihat juga Kebijakan Versi kami.

Jsonapidotnetcore	Status	.BERSIH	Inti Kerangka Entitas
3.x	Stabil	Inti 2.x	2.x
4.x	Stabil	Inti 3.1	3.1, 5
		5	5
		6	5
5.0.0-5.0.2	Stabil	6	6
5.0.3-5.4.0	Stabil	6	6, 7
		7	7
5.5+	Stabil	6	6, 7
		7	7
		8	8, 9
		9	9
menguasai	Pratinjau	8	8, 9
		9	9
Openapi	Eksperimental	8	8, 9
		9	9

Berkontribusi

Punya pertanyaan, menemukan bug atau ingin mengirimkan perubahan kode? Lihat Pedoman Kontribusi kami.

Mencoba bangunan terbaru

Setelah masing-masing berkomitmen untuk cabang master, paket nuget pra-rilis baru secara otomatis diterbitkan ke paket GitHub. Untuk mencobanya, ikuti langkah -langkah di bawah ini:

1. Buat token akses pribadi (klasik) dengan setidaknya read:packages Lingkup.

2. Tambahkan sumber paket kami ke file nuget.config khusus pengguna lokal Anda dengan menjalankan:

   dotnet nuget add source https://nuget.pkg.github.com/json-api-dotnet/index.json --name github-json-api --username YOUR-GITHUB-USERNAME --password YOUR-PAT-CLASSIC

   Dalam perintah di atas:

   • Ganti nama-github Anda dengan nama pengguna yang Anda gunakan untuk login akun GitHub Anda.
   • Ganti-Pat-Klasik Anda dengan token yang Anda buat di atas.

   ️ Jika perintah di atas tidak memberi Anda akses pada langkah berikutnya, hapus sumber paket dengan menjalankan:

   dotnet nuget remove source github-json-api

   dan coba lagi dengan sakelar --store-password-in-clear-text ditambahkan.

3. Mulai ulang IDE Anda, buka proyek Anda, dan telusuri daftar paket dari umpan GitHub-json-API (pastikan paket pra-rilis disertakan).

Perkembangan

Untuk membangun kode dari repositori ini secara lokal, jalankan:

dotnet build

Menjalankan tes secara lokal membutuhkan akses ke database PostgreSQL. Jika Anda telah menginstal Docker, ini dapat disangga melalui:

pwsh run-docker-postgres.ps1

Dan kemudian menjalankan tes:

dotnet test

Atau, untuk membangun, menjalankan semua tes, menghasilkan cakupan kode dan paket Nuget:

pwsh Build.ps1

Sponsor