SpringBoot实战（二）Restful风格API接口

在上一篇SpringBoot实战（一）HelloWorld的基础上，编写一个Restful风格的API接口：

1.根据MVC原则，创建一个简单的目录结构，包括controller和entity，分别创建User对象和UserController控制器：

User类：

package com.example.demo.controller.user.entity;

public class User {

    private Integer id;
    private String name;
    private String password;
    private String phone;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    public String getPhone() {
        return phone;
    }

    public void setPhone(String phone) {
        this.phone = phone;
    }
}

UserController

package com.example.demo.controller.user.controller;

import com.example.demo.controller.user.entity.User;
import org.springframework.web.bind.annotation.*;

import java.util.ArrayList;
import java.util.List;

/**
 * 通过RestController注解告知SpringBoot这是一个控制器类
 * 通过RequestMapping注解说明统一处理以user开头的URL请求
 */
@RestController
@RequestMapping("/user")
public class UserController {

    /**
     * 获取用户列表
     * @return
     */
    @GetMapping("/users")
    public List<User> userList(){
        List<User> result = new ArrayList<User>();

        for (int i = 0; i < 3; i++) {
            User user = new User();
            user.setId(i);
            user.setName("name_"+i);
            user.setPassword("password_"+i);
            user.setPhone("phone_"+i);
            result.add(user);
        }
        return result;
    }

    /**
     * 获取特定用户
     * @param id
     * @return
     */
    @GetMapping("/users/{id}")
    public User getUser(@PathVariable(value="id") Integer id){

        User user = new User();
        user.setId(id);
        user.setName("name_"+id);
        user.setPassword("password_"+id);
        user.setPhone("phone_"+id);
        return user;
    }

    /**
     * 添加用户
     * @param user
     * @return
     */
    @PostMapping("/add")
    public String addUser(@RequestBody User user){

        return "添加成功";
    }

    /**
     * 修改用户
     * @param id
     * @param user
     * @return
     */
    @PutMapping("/users/{id}/update")
    public String updateUser(@PathVariable(value="id") Integer id,@RequestBody User user){
        return "修改成功";
    }

    /**
     * 删除用户
     * @param id
     * @return
     */
    @DeleteMapping("/users/{id}/delete")
    public String deleteUser(@PathVariable(value="id") Integer id){

        return "删除成功";
    }
}

UserController包括了常用的Get、Post、Put、Delete请求，并使用注解的方式说明了请求路径

路径中的{id}元素是路径参数，可以通过@PathVariable注解获取，具体的参数获取与校验会在下一篇做介绍

使用Postman软件验证了所有接口都是可用的，部分截图如下：

Get：

Post

Put：