APIService_XML_JSON_JAVA_Servlet

Apiservice_xml_json_java_servlet

Implementierung eines API -Dienstes zur Abfrage nach Benutzerdaten, die in der XML -Datei gespeichert und dem Apiservlet zugeordnet sind und ein JSON -Array zurückgegeben werden können

API

Anwendungsprogrammierschnittstelle oder API ist ein Software -Vermittler, mit dem zwei Anwendungen miteinander sprechen können. Wenn Sie eine Anwendung auf Ihrem Mobiltelefon verwenden, passiert dies:

• Die Anwendung stellt eine Verbindung zum Internet her und sendet Daten an einen Server.
• Der Server ruft dann diese Daten ab, interpretiert sie und führt die erforderlichen Aktionen aus und sendet sie an Ihr Telefon zurück.
• Die Anwendung interpretiert dann diese Daten und präsentiert die Informationen, die Sie in einem lesbaren Format gewünscht haben. All dies geschieht durch eine API.

Aufgabendetails

Ihre Aufgabe ist es, einen API -Dienst zum Abfragen von Benutzerdaten zu implementieren, die im folgenden Format in com.he.api.data.xml gespeichert sind.

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

• <dataset> Tag ist das Root -Element im XML -Dokument. Es hat eine einzelne Attribut -ID_Auto_increment . Der Wert seiner ID nimmt wie folgt zu: Wert der Benutzer -ID, die zuletzt hinzugefügt wurde + 1

• <user /> Tag repräsentiert einen Benutzerdatensatz im Datensatz. Es hat folgende Attribute:

  • ID: Primärschlüssel der Benutzerdaten. Es ist ein ganzzahliger Wert.
  • FirstName: Vorname des Benutzers. Es ist ein Stringwert, der nur Kleinbuchstaben und Großbuchstaben des englischen Alphabets enthält.
  • IastName: Nachname des Benutzers. Es ist ein Stringwert, der nur Kleinbuchstaben und Großbuchstaben des englischen Alphabets enthält.

Der Anruf zum Server würde von scheme://domain:port/API?action=#&id=#&firstName=#&lastName=# , wo 'String' nach '?' bezeichnet die Abfragezeichenfolge.

Sie müssen einen API -Dienst implementieren, der dem Apiservlet (com.he.api.apiservlet.java) zugeordnet ist) Methode (bei URL Schema: // Domain: Port/API). Die Abfragebarstellung (lesen Sie hier mehr über Abfragebräge) kann folgende Parameter enthalten:

• Aktion: Definiert, welche Operationen ausgeführt werden müssen
• Ausweis
• Erstname
• Iastname

Arten von Abfragen

Die Abfragen können die folgenden Typen haben:

• action = searchByld & id =# : Suche nach ID im Datensatz in der Datei data.xml. Geben Sie ein JSON -Array zurück, das den ausgewählten Benutzer als Antwort enthält.

Beispiel URL: scheme://domain:port/API?action=searchById&id=1

Antwort:

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

• Action = SearchByFirstName & FirstName =# : Suche nach FirstName im Datensatz in der Datei data.xml. Geben Sie ein JSON -Array zurück, das die ausgewählten Benutzer als Antwort enthält.

Beispiel URL: scheme://domain:port/API?action=searchByFirstName&firstName=John

Antwort:

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

• Action = SearchByFirstName & iastName =# : Suche nach LastName im Datensatz in data.xml. Geben Sie ein JSON -Array zurück, das die ausgewählten Benutzer als Antwort enthält.

Beispiel URL: scheme://domain:port/API?action=searchByLastName&lastName=Doe

Antwort:

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

• Action = SearchByLdrange & Low =# & High =# : Suche nach ID im Datensatz in der Datei data.xml. Geben Sie ein JSON -Array zurück, das die ausgewählten Benutzer enthält, deren ID als Antwort im Bereich [niedrig, hoch] liegt.

Beispiel URL: scheme://domain:port/API?action=searchByIdRange&low=1&high=2

Antwort:

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

• action = updateUser & id =#& firstname =#& dastname =# : Aktualisieren Sie den Benutzer in der Datei data.xml, die durch ID angegeben ist, und setzen Sie den FirstName und den iastnamen auf angegebene Werte. Wenn der Parameter von FirstName oder IastName nicht vorhanden ist, bleibt der Wert unverändert. Es kann möglich sein, dass nur FirstName vorhanden ist und LastName NULL ist, dann muss nur der ersteName aktualisiert werden.

Beispiel 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 =# : Einfügen einen Benutzerdatensatz in die Datei data.xml mit den folgenden Parametern ein:
  • Erstname
  • Iastname

Die ID des Benutzers wird durch den Parameter id_auto_increment des Root -Datensatz -Tags angegeben. Nachdem der Wert eingefügt wurde, wird der Parameter id_auto_increment durch 1 erhöht.

Beispiel 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> 

Testen

Testen Sie Ihre API -Implementierung, indem Sie die Zuordnung Ihres JSON -Arrays und XML DOM vergleichen.