National_Parks_API

واجهة برمجة تطبيقات قاعدة بيانات المتنزهات الوطنية (تطبيق C# ASP .NET)

بقلم كريستا روتز

تطبيق API حيث يمكن للمستخدم الحصول على معلومات حول المتنزهات الوطنية ونشرها، والتي يتم استضافتها على GitHub. آخر تحديث 04.03.2020.

وصف

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

تم تطوير هذا المشروع بلغة C# على النظام الأساسي .NET Core مع معالجة الويب ASP.NET Core، باستخدام مكتبات أنماط MVC وقاعدة بيانات SQL. على وجه التحديد، تم إنشاء التطبيق باستخدام Entity Framework وMySQL لإنشاء المخطط، ويتم استضافته على GitHub.

تم إنشاؤه لمشروع Epicodus الأسبوع 13 المستقل يوم الجمعة، في الأسبوع 6 من دورة C# و.NET: "بناء واجهة برمجة التطبيقات".

مهارات إبيكودوس:

• ج #
• نمط MVC (مع ASP .NET Core 2.2)
• التوجيه المريح والخام
• عمليات ترحيل إطار الكيان
• MySQL Workbench والخادم
• التنمية المدفوعة بالسلوك (BDD)
• التحكم في إصدار Git وGitHub
• بناء واجهة برمجة تطبيقات RESTful

التثبيت / الإعداد

تم توثيق واجهة برمجة التطبيقات هذه بالكامل. ابحث عن الاستخدام والتفسيرات في مستند وثائق واجهة برمجة التطبيقات (API).

قم بتنزيل أو استنساخ المستودع لتشغيل هذا البرنامج محليًا!

يتطلب هذا البرنامج .NET Core SDK للتشغيل. فيما يلي برنامج تعليمي مجاني لتثبيت .NET على نظام التشغيل Mac أو Windows 10.

يستخدم هذا البرنامج أيضًا قواعد بيانات SQL. نوصي باستخدام MySQL Workbench لبناء قواعد البيانات الخاصة بك. فيما يلي برنامج تعليمي مجاني لتثبيت MySQL WorkBench وMySQL Community Server على نظام التشغيل Mac أو Windows 10.

• قم بتنزيل أو استنساخ هذا الريبو.
  • لتحميل الملف المضغوط:
    • حدد "تنزيل" على موقع مستودع GitHub
    • بمجرد التنزيل، افتح ملف ZIP واستخرج الملفات. سيتم إنشاء المجلد الجديد باسم "Week-13-Building-an-API-C-Sharp".
  • للاستنساخ:
    • استنساخ من سطر الأوامر إلى سطح المكتب الخاص بك: $ git clone https://github.com/KristaRutz/Week-13-Building-an-API-C-Sharp
    • سيتم إنشاء الدليل الجديد باسم "Desktop/Week-12-Advanced-Databases-and-Authentication-Project".
• بمجرد تخزين الملفات محليًا، قم بتنفيذ الأوامر التالية.
  • انتقل إلى دليل التطبيق: $ cd Desktop/Week-13-Building-an-API-C-Sharp/NationalParkDirectoryApi
  • $ dotnet restore
  • dotnet ef database update
  • dotnet build $
  • dotnet run $
• عند النجاح، سيبدأ تشغيل البرنامج في وحدة التحكم الخاصة بك.

التقنيات المستخدمة

• نت كور 2.2
  • جانب الخادم في C#
• قاعدة بيانات MySQL
• ساعي البريد

المواصفات

إنشاء واجهة برمجة التطبيقات للمتنزهات الحكومية والوطنية. سوف تسرد واجهة برمجة التطبيقات (API) المتنزهات الحكومية والوطنية. فيما يلي الميزات التي يجب تضمينها:

• يتضمن التطبيق وظيفة CRUD ويقوم بإرجاع الاستجابات لاستدعاءات API بنجاح.
• يتضمن التطبيق واحدًا على الأقل من أهداف الاستكشاف الإضافية: المصادقة، أو الإصدار، أو ترقيم الصفحات، أو وثائق Swagger، أو CORS.
• التطبيق موثق جيدًا، بما في ذلك وثائق محددة لمزيد من الاستكشاف.
• بمجرد إكمال متطلبات مراجعة التعليمات البرمجية، فكر في إضافة وظائف أخرى من الاستكشاف الإضافي يوم الاثنين. كن مبدعًا وأضف مسارات ونطاقات ووظائف مخصصة أخرى أيضًا. فيما يلي بعض الاحتمالات الأخرى التي يجب مراعاتها:
  • قم بإضافة نقطة نهاية RANDOM التي تُرجع متنزهًا بشكل عشوائي.
  • أضف نقطة نهاية مخصصة ثانية تقبل المعلمات. مثال: مسار بحث يسمح للمستخدمين بالبحث حسب أسماء منتزهات محددة.

ستتم مراجعة الكود الخاص بك لتحقيق الأهداف التالية:

• يتضمن التطبيق وظيفة CRUD ويقوم بإرجاع الاستجابات لاستدعاءات API بنجاح.

• يتضمن التطبيق واحدًا على الأقل من أهداف الاستكشاف الإضافية: المصادقة، أو الإصدار، أو ترقيم الصفحات، أو وثائق Swagger، أو CORS.

• التطبيق موثق جيدًا، بما في ذلك وثائق محددة لمزيد من الاستكشاف.

• يُظهر سجل الالتزام بوضوح ثماني ساعات من العمل.

الأخطاء المعروفة

• لا البق المعروفة

الدعم وتفاصيل الاتصال

الرجاء الاتصال بي إذا واجهت أي مشاكل أو لديك أسئلة أو أفكار أو مخاوف. يمكن الاتصال بي على [email protected]. لا تتردد في إنشاء طلب سحب للحصول على التحديثات - يتم تشجيع المساهمات في الكود!

رخصة

حقوق الطبع والنشر (ج) 2020 لكريستا روتز

تم ترخيص هذا البرنامج بموجب ترخيص MIT.

عرض تفاصيل الترخيص

يُمنح الإذن مجانًا لأي شخص يحصل على نسخة من هذا البرنامج وملفات الوثائق المرتبطة به ("البرنامج")، للتعامل في البرنامج دون قيود، بما في ذلك، على سبيل المثال لا الحصر، حقوق الاستخدام والنسخ والتعديل والدمج. ونشر و/أو توزيع وترخيص من الباطن و/أو بيع نسخ من البرنامج، والسماح للأشخاص الذين تم توفير البرنامج لهم بالقيام بذلك، وفقًا للشروط التالية:

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

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