JsonApiDotNetCore

jsonapidotnetcore

إطار عمل لبناء JSON: API API APIs باستخدام .NET Core و Entity Framework Core. يشمل الدعم للعمليات الذرية.

الهدف النهائي لهذه المكتبة هو القضاء على أكبر قدر ممكن من الغلاية من خلال تقديم ميزات خارج الصندوق مثل الفرز والتصفية والترقيم. تحتاج فقط إلى التركيز على تحديد الموارد وتنفيذ منطق عملك المخصص. تم تصميم هذه المكتبة حول حقن التبعية ، مما يجعل القابلية للتوسعة سهلة بشكل لا يصدق.

ابدء

هذه بعض الخطوات التي يمكنك اتخاذها لمساعدتك على فهم ماهية هذا المشروع وكيف يمكنك استخدامه:

عن

• ما هو JSON: API ولماذا يجب أن أستخدمه؟ (المدونة ، 2017)
• Pragmatic JSON: API Design (Video ، 2017)
• JSON: API و JSONAPIDOTNETCORE (فيديو ، 2021)
• JSONAPIDOTNETCORE الإصدار 4.0 (المدونة ، 2020)
• JSON: API ، .NET Core ، EmberJS (Video ، 2017)
• embercasts: ember الكامل الكامل مع ASP.NET Core (الدورة المدفوعة ، 2017)

الوثائق الرسمية

• JSON: مواصفات API
• موقع jsonapidotnetcore
• خريطة الطريق

المشاريع ذات الصلة

• تقارير الأداء
• jsonapidotnetcore.mongodb
• تطبيق قائمة ember.js todo

أمثلة

راجع دليل الأمثلة لتطبيقات عينة محدثة. يوجد أيضًا تطبيق قائمة TODO يتضمن API JSONAPIDOTNETCORE وعميل EMBERJS.

التثبيت والاستخدام

انظر وثائقنا للاستخدام التفصيلي.

النماذج

#nullable enable

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

الوسيطة

 // Program.cs

builder . Services . AddJsonApi < AppDbContext > ( ) ;

// ...

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

التوافق

يجب أن يساعدك المخطط التالي في اختيار أفضل إصدار ، استنادًا إلى بيئتك. انظر أيضا سياسة الإصدار لدينا.

jsonapidotnetcore	حالة	.شبكة	CHITITY Framework Core
3.x	مستقر	Core 2.x	2.x
4.x	مستقر	جوهر 3.1	3.1 ، 5
		5	5
		6	5
5.0.0-5.0.2	مستقر	6	6
5.0.3-5.4.0	مستقر	6	6 ، 7
		7	7
5.5+	مستقر	6	6 ، 7
		7	7
		8	8 ، 9
		9	9
يتقن	معاينة	8	8 ، 9
		9	9
Openapi	تجريبي	8	8 ، 9
		9	9

المساهمة

هل لديك سؤال أو العثور على خطأ أو تريد إرسال تغييرات الرمز؟ انظر إرشاداتنا المساهمة.

تجربة أحدث بناء

بعد كل الالتزام بالفرع الرئيسي ، يتم نشر حزمة Nuget جديدة مسبقًا تلقائيًا لحزم GitHub. لتجربتها ، اتبع الخطوات أدناه:

1. قم بإنشاء رمز وصول شخصي (كلاسيكي) مع على الأقل read:packages .

2. أضف مصدر الحزمة الخاص بنا إلى ملف nuget.config الخاص بالمستخدم المحلي عن طريق التشغيل:

   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

   في الأمر أعلاه:

   • استبدل اسم github-username باسم المستخدم الذي تستخدمه لتسجيل الدخول إلى حساب github الخاص بك.
   • استبدل كلاسيك كلاسيك بالرمز المميز الذي تم إنشاؤه أعلاه.

   ️ إذا لم يمنحك الأمر أعلاه إمكانية الوصول في الخطوة التالية ، فقم بإزالة مصدر الحزمة عن طريق التشغيل:

   dotnet nuget remove source github-json-api

   وأعيد إعادة المحاولة مع تبديل --store-password-in-clear-text .

3. أعد تشغيل IDE ، وافتح مشروعك ، وتصفح قائمة الحزم من تغذية GitHub-Json-Api (تأكد من تضمين حزم ما قبل الإصدار).

تطوير

لإنشاء الرمز من هذا المستودع محليًا ، قم بتشغيل:

dotnet build

يتطلب إجراء الاختبارات محليًا الوصول إلى قاعدة بيانات postgresql. إذا قمت بتثبيت Docker ، فيمكن رفع هذا عبر:

pwsh run-docker-postgres.ps1

ثم لإجراء الاختبارات:

dotnet test

بدلاً من ذلك ، لإنشاء جميع الاختبارات وتشغيلها وإنشاء تغطية الكود وحزم Nuget:

pwsh Build.ps1

الرعاة