Getting started with REST development

Making sure that the RESTful Web Services plugin is enabled

Even though the CDI Support plugin is enabled by default, it's always worth making sure that this plugin is still enabled before you start using CDI.

1. Open the Settings/Preferences dialog Ctrl+Alt+S.

2. In the left-hand part of the dialog, select Plugins.

3. In the right-hand part of the dialog, on the Plugins page, type restful in the search box. As a result, only the plugins whose names and descriptions contain restful are shown in the list of plugins.

4. If the checkbox to the right of Java EE: RESTful Web Services (JAX-RS) is not selected, select it.

5. Click OK in the Settings dialog.

6. If suggested, restart IntelliJ IDEA.

Enabling REST support when creating a project

1. If no project is currently open in IntelliJ IDEA, click Create New Project on the Welcome screen. Otherwise, select File | New | Project.

   As a result, the New Project wizard opens.

2. On the first page of the wizard, in the left-hand pane, select Java Enterprise. In the right-hand part of the page, specify the JDK to be used and select the Java EE version to be supported.

3. Under Additional Libraries and Frameworks, select the Restful Web Service checkbox.

4. You'll need a library that implements %tech_name%. the JAX-RS API. You can choose to use an existing library, create and use a new one, download the library files if they are not yet available on your computer, or postpone setting up the library until a later time.

   Use library	Select the library that you want to use (if the corresponding library is already defined in IntelliJ IDEA).
   Create	If the corresponding jar files are already available on your computer, you can arrange those files in a library. Click Create and select the necessary files in the dialog that opens. Optionally, click Configure to edit the selected library.
   Download	Select this option to download the necessary library files. Optionally, click Configure to edit the library settings and contents.
   Set up library later	Select this option to postpone setting up the library until a later time.

   Click Next.

5. Specify the name and location settings for your project and module.

   Click Finish.

Enabling REST support when adding a module to a project

1. Open the project you want to add a module to, and select File | New | Module.

   As a result, the New Module wizard opens.

2. On the first page of the wizard, in the left-hand pane, select Java Enterprise. In the right-hand part of the page, select the Java EE version to be supported.

3. Under Additional Libraries and Frameworks, select the Restful Web Service checkbox.

4. You'll need a library that implements %tech_name%. the JAX-RS API. You can choose to use an existing library, create and use a new one, download the library files if they are not yet available on your computer, or postpone setting up the library until a later time.

   Use library	Select the library that you want to use (if the corresponding library is already defined in IntelliJ IDEA).
   Create	If the corresponding jar files are already available on your computer, you can arrange those files in a library. Click Create and select the necessary files in the dialog that opens. Optionally, click Configure to edit the selected library.
   Download	Select this option to download the necessary library files. Optionally, click Configure to edit the library settings and contents.
   Set up library later	Select this option to postpone setting up the library until a later time.

   Click Next.

5. Specify the name and location settings for your module.

   Click Finish.

Enabling REST support for an existing module

1. Open the Project tool window (e.g. View | Tool Windows | Project).

2. Right-click the module of interest and select Add Framework Support.

3. In the left-hand pane of the Add Frameworks Support dialog that opens, select the RESTful Web Service checkbox.

4. You'll need a library that implements %tech_name%. the JAX-RS API. You can choose to use an existing library, create and use a new one, download the library files if they are not yet available on your computer, or postpone setting up the library until a later time.

   Use library	Select the library that you want to use (if the corresponding library is already defined in IntelliJ IDEA).
   Create	If the corresponding jar files are already available on your computer, you can arrange those files in a library. Click Create and select the necessary files in the dialog that opens. Optionally, click Configure to edit the selected library.
   Download	Select this option to download the necessary library files. Optionally, click Configure to edit the library settings and contents.
   Set up library later	Select this option to postpone setting up the library until a later time.

5. Click OK in the Add Frameworks Support dialog.