This site contains the documentation that is relevant to older WSO2 product versions and offerings.
For the latest WSO2 documentation, visit https://wso2.com/documentation/.
JAX-RS Basics
This sample demonstrates a basic REST-based Web Services using JAX-RS (JSR-311).
Building the sample
- Open a command line, and navigate to the
<EI_HOME>/samples/webapps/jaxrs_basic
directory. - Run the relevant command to deploy the web app:
Using Maven
Create a WAR file for the sample using the following command:
mvn clean install
Deploy the generated WAR file on WSO2 EI with the related logs on the console:
mvn -Pdeploy
Using Ant
ant
Start WSO2 EI by executing one of the following commands:
OS Command On Windows <EI_HOME>\bin\integrator.bat --run
On Linux/Solaris sh <EI_HOME>/bin/integrator.sh
Log in to the management console and click List on the Main menu, under Manage/Applications. This opens the Running Applications page. The deployed applications will be listed here.
Running the sample
You can invoke the JAX-RS web application as shown below.
Get the customer instance for customer ID 123 by sending an HTTP GET request to http://localhost:8280/jaxrs_basic/services/customers/customerservice/customers/123. The XML document returns the following:
<Customer> <id>123</id> <name>John</name> </Customer>
Get the product 323 that belongs to order 223 by sending an HTTP GET request to http://localhost:8280/jaxrs_basic/services/customers/customerservice/orders/223/products/323. The XML document returns the following:
<Product> <description>product 323</description> <id>323</id> </Product>
Add the customer named Jack by sending an HTTP POST request to http://localhost:8280/jaxrs_basic/services/customers/customerservice/customers as shown below.
<Customer> <name>Jack</name> </Customer>
Update the customer with ID 123 as shown below by sending an HTTP PUT request to http://localhost:8280/jaxrs_basic/services/customers/customerservice/customers.
<Customer> <id>123</id> <name>John</name> </Customer>
The client code demonstrates how to send HTTP GET/POST/PUT/DELETE requests; whereas, the server code demonstrates how to build a RESTful endpoint through JAX-RS (JSR-311) APIs.