Get started with REST development

Make sure that the RESTful Web Services plugin is enabled

1. In the Settings dialog (Ctrl+Alt+S) , select Plugins.

2. Make sure that the Jakarta EE: RESTful Web Services (JAX-RS) plugin is enabled.

3. Apply the changes and close the dialog. Restart the IDE if prompted.

Create a new Jakarta EE project with JAX-RS

1. Open the New Project wizard:

   • If you are on the Home screen, select New | Project….

   • If you have another project open, go to File | New | Project.

2. From the Generators list on the left, select Jakarta EE.

   

3. Select the REST service template and set up the rest of the Jakarta EE project settings.

   When you are ready, click Next.

4. From the Version drop-down list, select the Jakarta EE version you want to use.

5. (Optional) From the Dependencies list, select additional specifications or implementations you want to include in your project. Because of the REST service template, some specifications are already selected.

6. Click Create.

For more information about creating Jakarta EE projects, such as how to set up an application server, refer to Tutorial: Your first Jakarta EE application.

Add JAX-RS to an existing project

1. Open the build file in the editor (pom.xml or build.gradle depending on the build tool used in your project).

2. Add the JAX-RS library, and make sure its version matches the rest of your project:

   Jakarta EE

   <dependency> <groupId>jakarta.ws.rs</groupId> <artifactId>jakarta.ws.rs-api</artifactId> <version>4.0.0</version> </dependency>

   Java EE

   <dependency> <groupId>javax.ws.rs</groupId> <artifactId>javax.ws.rs-api</artifactId> <version>2.1.1</version> </dependency>

   Jakarta EE

   implementation 'jakarta.ws.rs:jakarta.ws.rs-api:4.0.0'

   Java EE

   implementation 'javax.ws.rs:javax.ws.rs-api:2.1.1'

   Jakarta EE

   implementation("jakarta.ws.rs:jakarta.ws.rs-api:4.0.0")

   Java EE

   implementation("javax.ws.rs:javax.ws.rs-api:2.1.1")

3. Press Ctrl+Shift+O to import the changes.

For more information about working with build tools, refer to Maven or Gradle.