APIService_XML_JSON_JAVA_Servlet

Apiservice_xml_json_java_servlet

تنفيذ خدمة API للاستعلام على بيانات المستخدم التي يتم تخزينها في ملف XML وتعيينها إلى طريقة Apiservlet GET وإعادة مجموعة JSON

API

واجهة برمجة التطبيقات أو واجهة برمجة التطبيقات هي وسيلة للبرامج التي تسمح للتطبيقين بـ "الحديث" مع بعضهما البعض. عند استخدام تطبيق على هاتفك المحمول ، هذا ما يحدث:

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

تفاصيل المهمة

تتمثل مهمتك في تطبيق خدمة API للاستعلام على بيانات المستخدم التي يتم تخزينها في com.he.api.data.xml بالتنسيق التالي.

    <dataset id_auto_increment="3"› 
      <user id="1" firstName="John" lastName="Dawson"/> 
      <user id="2" firstName="John" lastName="Doe"/> 
    </dataset>

• <dataset> العلامة هي عنصر الجذر في مستند XML. لديها سمة واحدة id_auto_increment . تزداد قيمة معرفه على النحو التالي: قيمة معرف المستخدم الذي تمت إضافته آخر + 1

• <user /> علامة تمثل سجل المستخدم في مجموعة البيانات. لها سمات التالية:

  • المعرف: المفتاح الأساسي لبيانات المستخدم. إنها قيمة عدد صحيح.
  • FirstName: الاسم الأول للمستخدم. إنها قيمة سلسلة تحتوي فقط على أحرف صغيرة وأحرف كبيرة من الأبجدية الإنجليزية.
  • iAStName: الاسم الأخير للمستخدم. إنها قيمة سلسلة تحتوي فقط على أحرف صغيرة وأحرف كبيرة من الأبجدية الإنجليزية.

سيتم إجراء المكالمة إلى الخادم بواسطة scheme://domain:port/API?action=#&id=#&firstName=#&lastName=# ، أين "السلسلة" بعد "؟" يدل على سلسلة الاستعلام.

يجب عليك تنفيذ خدمة API التي يتم تعيينها إلى Apiservlet (com.he.api.apiservlet.java) الحصول على طريقة (في مخطط url: // المجال: port/API). قد يكون لسلسلة الاستعلام (اقرأ المزيد حول سلاسل الاستعلام هنا) معلمات التالية:

• الإجراء: يحدد العمليات التي يجب تنفيذها
• بطاقة تعريف
• الاسم الأول
• iAStName

أنواع الاستفسارات

يمكن أن تكون الاستعلامات من الأنواع التالية:

• Action = searchbyld & id =# : ابحث عن طريق المعرف في مجموعة البيانات في ملف data.xml. إرجاع مجموعة JSON التي تحتوي على المستخدم المحدد كاستجابة.

مثال عنوان URL: scheme://domain:port/API?action=searchById&id=1

إجابة:

  [{ 
    "id": 1, 
    "firstName": "John", 
    "lastName": "Dawson" 
  }l 

• Action = searchByFirstName & FirstName =# : البحث عن طريق FirstName في مجموعة البيانات في ملف data.xml. إرجاع مجموعة JSON التي تحتوي على المستخدم (المستخدمين) المحدد كاستجابة.

مثال عنوان URL: scheme://domain:port/API?action=searchByFirstName&firstName=John

إجابة:

  [{ 
    "id": 1, 
    "firstName": "John", 
    "lastName": "Dawson" 
  }, { 
    "id": 2, 
    "firstName": "John", 
    "lastName": "Doe" 
  }] 

• Action = searchByFirstName & iAStName =# : البحث عن طريق اسمه في مجموعة البيانات في data.xml. إرجاع مجموعة JSON التي تحتوي على المستخدم (المستخدمين) المحدد كاستجابة.

مثال عنوان URL: scheme://domain:port/API?action=searchByLastName&lastName=Doe

إجابة:

  [{ 
    "id": 2, 
    "firstName": "John", 
    "lastName": "Doe" 
  }] 

• Action = searchbyldrange & low =# & high =# : البحث عن طريق المعرف في مجموعة البيانات في ملف data.xml. إرجاع مجموعة JSON التي تحتوي على المستخدم (المستخدمين) المحدد الذي يكون معرفه في النطاق [منخفض ، مرتفع] كاستجابة.

مثال عنوان URL: scheme://domain:port/API?action=searchByIdRange&low=1&high=2

إجابة:

  [{ 
    "id": 1, 
    "firstName": "John", 
    "lastName": "Dawson" 
  }, { 
    "id": 2, 
    "firstName": "John", 
    "lastName": "Doe" 
  }] 

• Action = updateUser & id =#& firstName =#& lastName =# : قم بتحديث المستخدم في ملف data.xml ، والذي يتم تقديمه بواسطة ID ، وتعيين FirstName و iAStName على القيم المعطاة. إذا لم تكن معلمة FirstName أو IASTNAME موجودة ، فسيتم ترك القيمة دون تغيير. قد يكون من الممكن أن يكون اسم FirstName فقط موجودًا وأن اسم LastName فارغ ، ثم يجب تحديث اسم FirstName فقط.

مثال عنوان URL: scheme://domain:port/API?action=updateUser&id=1&firstName=James&lastName=Jackson

  <dataset id auto increment="3"> 
    <user id="1" firstName="James" lastName="Jackson"/> 
    <user id="2" firstName="John" lastName="Doe"/> 
  </dataset> 

• Action = insertUser & FirstName =# & iaStName =# : أدخل سجل مستخدم في ملف data.xml باستخدام المعلمات التالية:
  • الاسم الأول
  • iAStName

يتم إعطاء معرف المستخدم بواسطة معلمة ID_AUTO_INCREMENT لعلامة مجموعة بيانات الجذر. بعد إدخال القيمة ، يتم زيادة معلمة ID_AUTO_INCREMENT بمقدار 1.

مثال URL: scheme://domain:port/API?action=insertUser&firstName=James&lastName=Jackson

  <dataset id auto increment="4"> 
    <user id="1" firstName="John" lastName="Dawson"/> 
    <user id="2" firstName="John" lastName="Doe"/>
    <user id="3" firstName="James" lastName="Jackson"/>
  </dataset> 

الاختبار

اختبر تطبيق API الخاص بك من خلال مقارنة تعيين مجموعة JSON و XML DOM.