# spring-resteasy: Example Using Resteasy Spring Integration

Weinan Li <l.weinan@gmail.com>, Paul Gier <pgier@redhat.com>

> The `spring-resteasy` quickstart demonstrates how to package and deploy a web application that includes resteasy-spring integration.

## What is it?

The `spring-resteasy` quickstart demonstrates how to package and deploy a web application, which includes resteasy-spring integration, in WildFly Application Server.

## System Requirements

The application this project produces is designed to be run on WildFly Application Server 12 or later.

All you need to build this project is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.1 or later. See Configure Maven to Build and Deploy the Quickstarts to make sure you are configured correctly for testing the quickstarts.

## Use of WILDFLY_HOME

In the following instructions, replace `WILDFLY_HOME` with the actual path to your WildFly installation. The installation path is described in detail here: Use of WILDFLY_HOME and JBOSS_HOME Variables.

## Start the WildFly Standalone Server

1. Open a terminal and navigate to the root of the WildFly directory.

2. Start the WildFly server with the default profile by typing the following command.

       $ WILDFLY_HOME/bin/standalone.sh

   Note | For Windows, use the `WILDFLY_HOME\bin\standalone.bat` script.

## Build and Deploy the Quickstart

1. Make sure you start the WildFly server as described above.

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

3. Type the following command to build the artifacts.

       $ mvn clean package wildfly:deploy

This deploys the `spring-resteasy/target/spring-resteasy.war` to the running instance of the server.

You should see a message in the server log indicating that the archive deployed successfully.

## Access the Application

The application will be running at the following URL: http://localhost:8080/spring-resteasy/.

That will provide links to the following URLs that demonstrate various path and parameter configurations.

- spring-resteasy/hello?name=yourname

- spring-resteasy/basic

- spring-resteasy/queryParam?param=query

- spring-resteasy/matrixParam;param=matrix

- spring-resteasy/uriParam/789

And the same set as above but using the `locating` path.

- spring-resteasy/locating/hello?name=yourname

- spring-resteasy/locating/basic

- spring-resteasy/locating/queryParam?param=query

- spring-resteasy/locating/matrixParam;param=matrix

- spring-resteasy/locating/uriParam/789

## Undeploy the Quickstart

When you are finished testing the quickstart, follow these steps to undeploy the archive.

1. Make sure you start the WildFly server as described above.

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

3. Type this command to undeploy the archive:

       $ mvn wildfly:undeploy

## Run the Arquillian Functional Tests

This quickstart provides Arquillian functional tests. They are located under the `functional-tests/` directory. Functional tests verify that your application behaves correctly from the user’s point of view and simulate clicking around the web page as a normal user would do.

Note | The Arquillian functional tests deploy the application, so make sure you undeploy the quickstart before you begin.

Follow these steps to run the functional tests.

1. Start the WildFly server as described above.

2. Build the quickstart archive.

   1. Open a terminal and navigate to the root directory of this quickstart.

   2. Build the quickstart archive using the following command:

          $ mvn clean package

3. Navigate to the `functional-tests/` directory in this quickstart.

4. Type the following command to run the `verify` goal with the `arq-remote` profile activated.

       $ mvn clean verify -Parq-remote

Note | You can also let Arquillian manage the WildFly server by using the `arq-managed` profile, meaning the tests will start the server for you. This profile requires that you provide Arquillian with the location of the WildFly server, either by setting the `JBOSS_HOME` environment variable, or by setting the `jbossHome` property in the `arquillian.xml` file. For more information, see Run the Arquillian Tests.

## Deploy the Quickstart to OpenShift Online

Use these instructions to deploy the quickstart to Red Hat OpenShift Online. If you do not yet have an OpenShift Online account and are interested in signing up for one, see Choose a Plan in the OpenShift Online documentation located on the Red Hat Customer Portal. For information about running JBoss EAP on Red Hat OpenShift Online, see Getting Started with JBoss EAP for OpenShift Online, also located on the Red Hat Customer Portal.

### Create and Deploy the Quickstart Project

Follow these instructions to deploy this quickstart to OpenShift Online.

1. Browse to OpenShift Online console and login with your credentials.

2. On the View All Projects or Welcome to Project page, click Create Project.

3. On the Create Project page, enter the following information:

       Name:  spring-resteasy
       Display Name spring-resteasy
       Description: spring-resteasy

4. Click Create to create the project.

5. On the My Projects page, choose your new spring-resteasy and click Browse Catalog.

6. Choose JBoss EAP CD (no https) and then click Next to view the Information page.

7. Click Next to navigate to the Configuration page. . . Enter the following information. You can leave the remaining fields as they are.

       Add to Project: spring-resteasy
       Application Name: spring-resteasy
       Custom http Route Hostname: (leave blank)
       Git Repository URL: https://github.com/wildfly/quickstart/
       Git Reference: master
       Context directory: spring-resteasy

8. Click the Create button.

9. Click on the Continue to the project overview link.

   - You should see "Build #1 is running …​" with the console log below.

         Cloning ...
         Downloading ...
         Building ...
         Copying ...
         Pushing ...

   - At the end of the build, you should see "Push successful".

   - Click View Full Log to see the entire log.

10. Click the Overview tab to see the `spring-resteasy` deployment.

11. Click on the application URL on the right side of the page to view the running application. It should be in the following pattern:

        http://APPLICATION_NAME-PROJECT_NAME.PORT.HOST.openshiftapps.com

### Delete the Quickstart Project

Follow these instructions to delete the project from OpenShift Online.

1. Go to the View All Projects page and select Delete Project from the drop down list to the right of the spring-resteasy project.

2. Type the name of the project to confirm, and then click Delete

## Run the Quickstart in Red Hat JBoss Developer Studio or Eclipse

This quickstart is not supported in Red Hat JBoss Developer Studio.