helloworld-rs: Helloworld Using JAX-RS (Java API for RESTful Web Services)

Author: Gustavo A. Brey, Gaston Coco
Level: Intermediate
Technologies: CDI, JAX-RS
Summary: The helloworld-rs quickstart demonstrates a simple Hello World application, bundled and deployed as a WAR, that uses JAX-RS to say Hello.
Target Product: ${product.name}
Source: <${github.repo.url}>

What is it?

The helloworld-rs quickstart demonstrates the use of CDI and JAX-RS in ${product.name.full}.

System Requirements

The application this project produces is designed to be run on ${product.name.full} ${product.version} or later.

All you need to build this project is ${build.requirements}. See Configure Maven for ${product.name} ${product.version} to make sure you are configured correctly for testing the quickstarts.

Use of ${jboss.home.name}

In the following instructions, replace ${jboss.home.name} with the actual path to your ${product.name} installation. The installation path is described in detail here: Use of ${jboss.home.name} and JBOSS_HOME Variables.

Start the Server

1. Open a command prompt and navigate to the root of the ${product.name} directory.

2. The following shows the command line to start the server:

    For Linux:   ${jboss.home.name}/bin/standalone.sh
    For Windows: ${jboss.home.name}\bin\standalone.bat
   

Build and Deploy the Quickstart

1. Make sure you have started the ${product.name} server as described above.

2. Open a command prompt and navigate to the root directory of this quickstart.

3. Type this command to build and deploy the archive:

    mvn clean install wildfly:deploy
   

4. This will deploy target/${project.artifactId}.war to the running instance of the server.

Access the Application

The application is deployed to http://localhost:8080/${project.artifactId}/.

The XML content can be viewed by accessing the following URL: http://localhost:8080/${project.artifactId}/rest/xml

The JSON content can be viewed by accessing this URL: http://localhost:8080/${project.artifactId}/rest/json

Undeploy the Archive

1. Make sure you have started the ${product.name} server as described above.

2. Open a command prompt and navigate to the root directory of this quickstart.

3. When you are finished testing, type this command to undeploy the archive:

    mvn wildfly:undeploy
   

Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse

You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a ${product.name} server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.

Debug the Application

If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.

    mvn dependency:sources