详解使用IntelliJ IDEA新建Java Web后端resfulAPI模板

下面我会为您详细讲解如何使用IntelliJ IDEA新建Java Web后端restful API模板。

步骤一：新建Maven项目

以IntelliJ IDEA 2021.1版本为例，首先我们需要新建一个Maven项目。

1. 打开IntelliJ IDEA，点击“Create New Project”。
2. 选择Maven并点击“Next”。
3. 输入GroupId、ArtifactId和Version，并点击“Next”。
4. 选择项目的存储路径，并点击“Finish”。

步骤二：添加依赖

接下来，我们需要添加一些依赖，这些依赖可以帮助我们构建Java Web后端restful API模板。

1. 在“pom.xml”中添加以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>   

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-test</artifactId>
    <scope>test</scope>
</dependency>   

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
</dependency>

1. 点击“Reimport”。

步骤三：新建控制器

在这一步中，我们需要新建控制器来处理与客户端的通信。下面是一个控制器示例，它将处理HTTP Get请求，并返回一条简单的消息。

@RestController
public class HelloController {

    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    public String hello() {
        return "Hello, World!";
    }

}

步骤四：运行项目

完成控制器的编写之后，我们需要启动项目，并测试我们的控制器是否可以正常工作。

1. 点击IntelliJ IDEA界面中的“Run”按钮。
2. 访问http://localhost:8080/hello，应该能够看到“Hello, World!”这条消息。

示例一

接下来我将以一个简单的用户管理系统为例，展示如何使用新建的restful API模板。这个系统包括两个主要功能：获取用户信息和添加用户信息。

@RestController
public class UserController {

    private static List<User> users = new ArrayList<>();

    static {
        users.add(new User(1, "张三", 20));
        users.add(new User(2, "李四", 25));
        users.add(new User(3, "王五", 30));
    }

    @RequestMapping(value = "/users", method = RequestMethod.GET)
    public List<User> getUsers() {
        return users;
    }

    @RequestMapping(value = "/users", method = RequestMethod.POST)
    public ResponseEntity<Void> addUser(@RequestBody User user) {
        users.add(user);
        return new ResponseEntity<>(HttpStatus.CREATED);
    }

}

示例二

我们也可以使用Spring Boot自动生成RESTful API的代码。只需遵循以下步骤：

1. 在IntelliJ IDEA中创建一个新的Spring Boot项目。
2. 添加以下依赖项：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-data-rest</artifactId>
</dependency>

1. 创建一个实体类：

@Entity
public class User {
    @Id
    @GeneratedValue
    private Long id;

    private String name;

    private Integer age;

    // getter and setter
}

1. 创建一个repository接口：

@RepositoryRestResource(collectionResourceRel = "users", path = "users")
public interface UserRepository extends JpaRepository<User, Long> {
}

至此，我们已经成功创建了一个RESTful API。