JAX-RS-Web-Service erstellen

Vorbereitende Schritte

Zur Implementierung des Web-Service müssen Sie über einen Server mit Java™ ab Version 5.0 und definierter und gestarteter JVM-Unterstützung verfügen. Dies umfasst Folgendes:
  • Bei WebSphere Application Server Version 7.0 oder Version 8.0 wählen Sie aus, dass das Feature Pack for Web 2.0 AND MOBILE und die WebSphere Application Server-Entwicklungstools installiert werden sollen.
Standardmäßig wird ein Server für Sie bei der Installation von WebSphere Application Server erstellt. Dieser Server wird in der Ansicht 'Server' angezeigt.

Wenn Sie auswählen, dass die Implementierung auf einem anderen Server als dem WebSphere Application Server erfolgen soll, können Sie die IBM JAX-RS-Bibliothek nicht verwenden und müssen Ihre eigenen JAX-RS-Bibliotheken über die Seite mit den Benutzervorgaben für Projektfacetten > JAX-RS konfigurieren.

Detaillierte Informationen zur Verwendung von JAX-RS-Web-Services in WebSphere Application Server finden Sie im WebSphere Application Server Information Center.

JAX-RS-fähiges Webprojekt erstellen

Informationen zu diesem Vorgang

Der JAX-RS-Web-Service muss sich in einem Projekt befinden, bei dem die JAX-RS-Facette aktiviert ist.
Einschränkung: [Liberty] Um die JAX-RS 2.0-APIs nutzen zu können, müssen Sie eine Benutzerbibliothek erstellen und die Datei com.ibm.ws.javaee.jaxrs.2.0_1.0.0.jar, die im Ordner dev/api/spec der Liberty-Laufzeit enthalten ist, angeben. Geben Sie diese Benutzerbibliothek im Java-Erstellungspfad des Projekts vor dem Klassenpfadcontainer des Liberty-Servers an.

[WebSphere Application Server Traditional] WebSphere Application Server Traditional Version 9 unterstützt JAX-RS 1.1 und JAX-RS 2.0. Die JAX-RS-Version, die Sie in Ihrem Projekt verwenden, muss mit der JAX-RS-Version, die Sie in Ihrer Installation von WebSphere Application Server Traditional Version 9 verwenden, übereinstimmen. Stimmen diese Versionen nicht überein, zeigen die Tools eine Warnung an, wenn Sie Ihr Projekt auf dem Server implementieren. Wenn Sie ein JAX-RS-Projekt erstellen, ohne eine Facettenstufe anzugeben, verwenden die Tools standardmäßig JAX-RS 2.0.

[WebSphere Application Server Traditional] Wenn Sie ein JAX-RS 1.1-Modul einem Webprojekt hinzufügen, geben die Tools die folgenden Dateien im Klassenpfadcontainer an:
com.ibm.ws.jaxrs.jar
com.ibm.ws.prereq.jaxrs.jar
javax.j2ee.jaxrs.jar
[WebSphere Application Server Traditional] Wenn Sie ein JAX-RS 2.0-Modul einem Webprojekt hinzufügen, geben die Tools die folgenden Dateien im Klassenpfadcontainer an:
com.ibm.ws.jaxrs20.jar
com.ibm.ws.prereq.jaxrs20.jar
javax.ws.rs-api-2.0.jar

Vorgehensweise

  1. Klicken Sie in der Java EE-Perspektive mit der rechten Maustaste auf Ihr EAR-Projekt und wählen Sie Neu > Webprojekt aus, um den Webprojektassistenten zu öffnen.
  2. Geben Sie im Feld Name einen Namen für Ihr neues Webprojekt ein.
  3. Wählen Sie im Bereich der Projektschablonen den Typ der Webschablone aus, den Sie verwenden möchten: Wählen Sie Einfach aus, um ein einfaches Webprojekt zu erstellen.
  4. Wählen Sie im Abschnitt "Programmiermodell" das Programmiermodell aus, das Sie verwenden möchten: Wählen Sie Java EE-Programmiermodell aus. Klicken Sie auf Weiter, um Ihr neues Webprojekt zu konfigurieren.
  5. Klicken Sie auf der Seite für die Implementierung aus der Liste der verfügbaren Konfigurationsoptionen auf Implementierung, um die Seite für die Implementierungskonfiguration zu öffnen.
    • Sie können das Feld Ziellaufzeitkomponente ändern, indem Sie eine andere Komponente aus der Dropdown-Liste auswählen. Klicken Sie auf die Option Features ändern, um das Fenster Projektfacetten zu öffnen. Wählen Sie auf der Seite mit den Projektfacetten JAX-RS (REST Web Services) aus und klicken Sie auf OK.
    • Klicken Sie auf Support für WebSphere-Bindings und -Erweiterungen hinzufügen oder inaktivieren Sie dieses Feld.
    • Wählen Sie im Feld Webmodulversion die Webmodulversion aus, die Sie verwenden möchten.
    • Klicken Sie im Feld EAR-Zugehörigkeit auf Projekt einer EAR hinzufügen, wenn Sie die EAR-Zugehörigkeit hinzufügen möchten. Inaktivieren Sie dieses Feld, wenn der EAR-Datei das Webprojekt nicht hinzugefügt werden soll.
    • Im Feld Name des EAR-Projekts wird der Name der vorhandenen EAR-Datei angezeigt. Sie können auf Durchsuchen klicken, um eine andere EAR-Datei auszuwählen.
    Anmerkung: Die Implementierungsoption ist nicht verfügbar, wenn Sie als Programmiermodell für Ihr neues Webprojekt die Option "Nur clientseitig" ausgewählt haben.
  6. Klicken Sie in der Liste verfügbarer Konfigurationsoptionen auf REST-Services.
    1. Wählen Sie im Feld JAX-RS-Implementierungsbibliothek die Bibliothek für Ihre Serverversion aus. Beispiel: IBM WebSphere Application Server v8.0 JAX-RS Library oder IBM WebSphere Application Server 8.5 JAX-RS Library.
      Weitere Informationen zu Bibliotheken: Die JAX-RS-Bibliotheken für alle von Ihnen installierten WebSphere-Testumgebungen sind in dieser Dropdown-Liste aufgeführt. Falls Sie eine Nicht-WebSphere-Bibliothek verwenden möchten, kann diese mithilfe der Benutzervorgabenseite zur Benutzerbibliothek importiert werden. Falls Sie 'Benutzerbibliothek' auswählen, können Sie die Benutzervorgabenseite zur Benutzerbibliothek aufrufen und eine Bibliothek hinzufügen. Sobald ein Projekt erstellt wurde, können Sie die Bibliothek ändern, indem Sie mit der rechten Maustaste auf Ihr Projekt klicken und Benutzervorgaben > Projektfacetten > JAX-RS auswählen. Sie können auch auswählen, dass der Assistent die Bibliothek nicht für Sie konfiguriert. In diesem Fall müssen Sie den Klassenpfad manuell konfigurieren.
    2. Falls Sie eine Version von WebSphere Application Server verwenden, die älter als Version 8 ist, markieren Sie Bibliothek in diese Anwendung einbeziehen und wählen danach aus, dass die Bibliothek als gemeinsam genutzte Bibliothek einbezogen wird. Wählen Sie dazu die Option Gemeinsam genutzte Bibliothek aus. Dadurch werden JAX-RS-JAR-Dateien zum Klassenpfad hinzugefügt und ein Eintrag über die gemeinsam genutzte Bibliothek wird in der erweiterten EAR-Datei hinzugefügt.
    3. Implementierungsdeskriptor aktualisieren ist standardmäßig ausgewählt, weil Sie eine Datei web.xml verwenden müssen, um Integritätsbedingungen für die Sicherheit und andere Verhalten zu konfigurieren. Eine Datei web.xml wird auch dann generiert und mit JAX-RS-Servletinformationen aktualisiert, wenn Sie im Assistenten zuvor ausgewählt haben, dass kein Implementierungsdeskriptor generiert werden soll. Diese Option ist nur verfügbar, wenn die ausgewählte Web Modules-Facette eine Version ab Version 3.0 aufweist.
    4. Falls Sie ausgewählt haben, dass der Implementierungsdeskriptor aktualisiert werden soll, können Sie den Servletnamen und den Servletklassennamen sowie die URL-Zuordnungsmuster ändern.
  7. Klicken Sie in der Liste der verfügbaren Konfigurationsoptionen auf Java, um die Java-Konfigurationsseite zu öffnen.
    • Akzeptieren Sie im Feld zu den Quellenordnern im Erstellungspfad das Standardverzeichnis src oder klicken Sie auf Ordner hinzufügen, Bearbeiten... oder Entfernen, um einen Ordner für Ihre Quellendateien anzugeben.
    • Geben Sie im Feld für den Standardausgabeordner einen Ordner für Ihre Ausgabedateien an oder akzeptieren Sie den Standardwert (WebContent\WEB-INF\classes).
  8. Klicken Sie in der Liste der verfügbaren Konfigurationsoptionen auf Webmodul. Gehen Sie auf der Seite Webmodulkonfiguration wie folgt vor:
    • Geben Sie im Feld Kontextstammverzeichnis den Namen Ihre Webprojektstammverzeichnisses ein oder akzeptieren Sie den Standardwert (den Namen Ihres Webprojekts).
    • Geben Sie in das Feld für das Content-Verzeichnis den Namen Ihres Content-Verzeichnisses ein oder akzeptieren Sie den Standardwert (WebContent).
    • Wählen Sie die Option zum Generieren des Implementierungsdeskriptors "web.xml" aus, wenn Sie einen Implementierungsdeskriptor erstellen möchten. Sie können Ihrem Webmodul auch später einen Implementierungsdeskriptor hinzufügen.
  9. Klicken Sie auf Fertigstellen.

JAX-RS-Web-Service erstellen

Vorgehensweise

  1. Erstellen Sie in Ihrem Webprojekt ein Paket (klicken Sie mit der rechten Maustaste auf Java-Ressourcen > src und wählen Sie Neu > Paket aus). Importieren Sie die Klassen für den Web-Service in das Paket.
  2. Öffnen Sie die Datei WebContent/WEB-INF/web.xml. In der Entwurfsansicht wählen Sie das JAX-RS-Servlet aus und klicken auf Hinzufügen. Fügen Sie einen Initialisierungsparameter zum JAX-RS-Servlet hinzu und lassen Sie die Felder für Name und Wert leer. Speichern Sie die Datei web.xml und ignorieren Sie alle Fehler, die möglicherweise angezeigt werden.
  3. Wählen Sie in der Ansicht mit den Markierungen den web.xml-Fehler bei param-name aus, klicken Sie mit der rechten Maustaste und wählen Sie Schnellkorrektur aus. Blättern Sie zu der Anwendung und treffen Sie Ihre Auswahl.
  4. Fügen Sie die EAR-Datei mit dem JAX-RS-Projekt zum Server hinzu und starten Sie den Server.

Ergebnisse

Jede Webanwendung muss ein Kontextstammverzeichnis haben, damit die Webanwendung erfolgreich implementiert werden kann. Ein Kontextstammelement für jedes Webmodul wird während der Anwendungsassemblierung oder der Anwendungsimplementierung im Anwendungsimplementierungsdeskriptor definiert. Das Kontextstammverzeichnis wird mit der definierten Servlet-Zuordnung (aus der WAR-Datei) zum vollständigen URL kombiniert, den die Benutzer eingeben müssen, um auf das Servlet zugreifen zu können. Die Kontextstammverzeichnis aller implementierten Webanwendungen müssen auf dem Server eindeutig sein. Das Kontextstammelement kann auch leer sein.

Falls zum Beispiel eine Webanwendung das Kontextstammelement sample/application/ verwendet hat, beginnt die Anforderungs-URL der Webanwendung mit http://<hostname>:<port>/sample/application/. Das URL-Muster eines Servlets wird an das Kontextstammelement der Webanwendung angehängt. Falls das Kontextstammelement sample/application/ lautet und die Servlet-URL-Zuordnung rest/api/* lautet, so ist der Basis-URI für die JAX-RS-Webanwendung http://<Hostname>:<Port>/sample/application/rest/api.

JAX-RS-Projekt bearbeiten

Sobald Sie einen JAX-RS-Web-Service erstellt haben, können Sie ihn bearbeiten, indem Sie mit der rechten Maustaste auf das Projekt klicken und Eigenschaften > Projektfacetten > JAX-RS auswählen. Auf dieser Seite können Sie Folgendes ändern:
  • Bibliothekstyp
  • JAX-RS-Servletname
  • JAX-RS-Servletklassenname
  • URL-Zuordnungsmuster
Wenn Sie Ihr Projekt beispielsweise auf einen anderen Server migrieren, können Sie den Bibliotheksprovider in einen anderen Provider ändern, der vom neuen Server unterstützt wird.
Icon that indicates the type of topic Task topic
Timestamp icon Last updated: last_date

File name: tjaxrswebservcreate.html