aspnet quickstart minapi user profile

QuickStart في Couchbase مع C# و ASP.NET 6 الحد الأدنى من واجهة برمجة التطبيقات

بناء API REST مع Couchbase's C# SDK 3 و ASP.NET الحد الأدنى API

تم تصميم هذا الريبو لتعليمك كيفية الاتصال بمجموعة Couchbase لإنشاء المستندات والقراءة والتحديث وحذفها وكيفية كتابة استعلامات N1QL البسيطة باستخدام إطار API Minimity API الجديد.

يمكن العثور على الوثائق الكاملة على بوابة مطور Couchbase.

المتطلبات الأساسية

لتشغيل هذا المشروع المسبق ، ستحتاج إلى:

• اتبع خيارات تثبيت Couchbase لتثبيت أحدث مثيل خادم قاعدة بيانات Couchbase
• .NET SDK V6+ مثبت
• تم تثبيت محرر الكود (Visual Studio Professional ، Visual Studio لنظام التشغيل Mac ، أو Visual Studio Code)

تثبيت التبعيات

 cd src/Couchbase.Quickstart
dotnet restore

ملاحظة: Nuget Packages Auto Restore عند بناء المشروع في Visual Studio Professional and Visual Studio لـ Mac

حزمة Nuget التبعية

يتضمن Couchbase SDK لـ .NET حزمة nuget تسمى Couchbase.Extensions.DependencyInjection التي تم تصميمها لبيئات مثل ASP.NET التي تأخذ في تكوين للاتصال بـ Couchbase وتسجيل واجهات تلقائيًا التي يمكنك استخدامها في الكود الكامل CRUD (create, read, update, delete) عمليات المقالات ومسائلها.

تكوين خادم قاعدة البيانات

يتم تخزين جميع التكوينات للاتصال مع قاعدة البيانات في ملف Appsettings.Development.json. يتضمن ذلك سلسلة الاتصال ، اسم المستخدم ، كلمة المرور ، اسم الجرافة ، اسم Colleciton ، واسم النطاق. من المفترض أن يكون اسم المستخدم الافتراضي هو admin ويفترض أن كلمة المرور الافتراضية هي P@$$w0rd12 . إذا كانت هذه مختلفة في بيئتك ، فستحتاج إلى تغييرها قبل تشغيل التطبيق.

إنشاء دلو واسم المستخدم وكلمة المرور

باستخدام هذا البرنامج التعليمي ، يجب إنشاء مستخدم وقاعدة بيانات دلو قبل تشغيل التطبيق.

مستخدمي كابيلا

بالنسبة لمستخدمي Capella ، اتبع الإرشادات الموجودة على موقع الوثائق لإنشاء دلو يسمى user_profile . بعد ذلك ، اتبع الإرشادات الخاصة بتكوين بيانات اعتماد قاعدة البيانات ؛ اسم admin مع كلمة مرور من P@$$w0rd12 .

بعد ذلك ، افتح ملف appsettings.development.json. حدد موقع خاصية ConnectionString وقم بتحديثها لتطابق اسم شبكة المنطقة الواسعة الموجودة في علامة التبويب Capella Portal UI Connect. لاحظ أن Capella يستخدم TLS بحيث يجب أن تبدأ سلسلة الاتصال بـ Couchbases: //. تم تصميم هذا التكوين لبيئات التطوير فقط.

  "Couchbase" : {
    "BucketName" : " user_profile " ,
    "ScopeName" : " _default " ,
    "CollectionName" : " profile " ,
    "ConnectionString" : " couchbases://yourassignedhostname.cloud.couchbase.com " ,
    "Username" : " admin " ,
    "Password" : " P@$$w0rd12 " ,
    "IgnoreRemoteCertificateNameMismatch" : true ,
    "HttpIgnoreRemoteCertificateMismatch" : true ,
    "KvIgnoreRemoteCertificateNameMismatch" :  true
  }

سيحصل مستخدمو Couchbase Capella الذين لا يتبعون هذه الاتجاهات على أخطاء استثناء وستقوم بوابة Swagger بإرجاع الأخطاء عند تشغيل واجهات برمجة التطبيقات.

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

للتثبيت المحلي ومستخدمي Docker ، اتبع الإرشادات الموجودة على موقع الوثائق لإنشاء دلو يسمى user_profile . بعد ذلك ، اتبع الإرشادات لإنشاء مستخدم ؛ اسم admin مع كلمة مرور من P@$$w0rd12 . بالنسبة لهذا البرنامج التعليمي ، تأكد من أن لديه حقوق Full Admin حتى يتمكن التطبيق من إنشاء مجموعات وفهارس.

بعد ذلك ، افتح ملف appsettings.development.json والتحقق من صحة معلومات التكوين يطابق الإعداد الخاص بك.

ملاحظة: بالنسبة إلى عمليات تثبيت Docker و Couchbase المحلية ، يجب تثبيت Couchbase وتشغيله على LocalHost (http://127.0.0.1:8091) قبل تشغيل تطبيق ASP.NET.

تشغيل التطبيق

في هذه المرحلة ، يكون التطبيق جاهزًا ويمكنك تشغيله:

 cd src/Couchbase.Quickstart
dotnet run

بمجرد تشغيل الموقع وتشغيله ، يمكنك تشغيل متصفحك والانتقال إلى صفحة بدء Swagger لاختبار واجهات برمجة التطبيقات.

إدارة الاختبارات

لتشغيل اختبارات التكامل القياسية ، استخدم الأوامر التالية:

 cd ../Couchbase.Quickstart.IntegrationTests/
dotnet restore 
dotnet build
dotnet test 

ملاحظات إعداد المشروع

استند هذا المشروع إلى مشروع قالب ASP.NET القياسي وتمت إزالة واجهة برمجة تطبيقات الطقس الافتراضية.

خاتمة

يعد إعداد API REST الأساسي في ASP.NET الحد الأدنى من واجهات برمجة التطبيقات مع Couchbase بسيطًا إلى حد ما. سيتم إنشاء هذا المشروع عند تشغيل مجموعة ، فهرس لاستعلام N1QL المعلمة ، ويعرض عمليات CRUD الأساسية المطلوبة في معظم التطبيقات.