RESTful风格api

REST就是指对同一个URI的资源的不同请求方式(GET,POST,PUT,DELETE)(表述)下的做出的不同的操作(查,增,改,删),改变的是资源的状态,即表述性状态转移。 一个符合REST风格的URI就可以称之一个RESTful的接口
在这里插入图片描述
用户实体类

package com.offcn.springboot01.pojo;

import com.fasterxml.jackson.annotation.JsonFormat;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.ToString;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.stereotype.Repository;

import java.io.Serializable;
import java.util.Date;

/**
 * @author zhangzhibin
 * @create 2021-04-12 10:02
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
@ToString
public class User implements Serializable {
    private String name;
    private Integer age;
    private String address;
}


package com.offcn.springboot01.controller;
import com.offcn.springboot01.pojo.User;
import org.springframework.web.bind.annotation.*;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

/**
 * 同一个URI http://localhost:8088/restful/add  delete  put  get
 * http不通请求方式
 * 对应不同的接口 增删改查
 */
@RestController
@RequestMapping("restful")
public class RESTfulController {
    private List<User> listUser= Collections.synchronizedList(new ArrayList<User>());
    /***
     * 获取全部用户信息
     */
    @GetMapping("/user")
    public List<User> getUserList(){
        return listUser;
    }

    /***
     * 新增用户
     */
    @PostMapping("/user")
    public String createUser(User user) {
        listUser.add(user);
        return "success";
    }

    /***
     * 获取指定id用户信息
     */
    @GetMapping("/user/{id}")
    public User getUser(@PathVariable("id")Long id) {
        for (User user : listUser) {
            if(user.getId()==id) {
                return user;
            }
        }
        return null;
    }
    /**
     * 更新指定id用户信息
     */
    @PutMapping("/user/{id}")
    public String updateUser(@PathVariable("id") Long id,User user) {
        for (User user2 : listUser) {
            if(user2.getId()==id) {
                user2.setName(user.getName());
                user2.setAge(user.getAge());
            }
        }
        return "success";
    }

    /***
     * 删除指定id用户
     * @param id
     * @return
     */
    @DeleteMapping("/user/{id}")
    public String deleteUser(@PathVariable("id") Long id) {
        listUser.remove(getUser(id));
        return "success";
    }
}
设计 RESTful 风格 API 的 URL,通常需要考虑以下几个方面: 1. 遵循 URL 的命名规范:URL 命名应该简洁易懂,采用小写字母和短划线进行分隔。 2. 使用名词表示资源:RESTful API 设计中的 URL 应该是名词,而不是动词。例如,使用 `/users` 表示用户资源,而不是 `/get_users`。 3. 使用 HTTP 动词表示操作:RESTful API 设计中的 HTTP 方法应该表示所要执行的操作。例如,使用 HTTP GET 方法获取资源,使用 POST 方法创建资源,使用 PUT 方法更新资源,使用 DELETE 方法删除资源。 4. 使用路径参数和查询参数:使用路径参数表示资源的唯一标识符,使用查询参数表示对资源的筛选和排序操作。 下面以一个简单的例子说明如何设计 RESTful 风格 API 的 URL: 假设我们要设计一个博客网站的 API,其中包含文章和评论两个资源。文章可以被创建、查看、更新和删除,评论可以被创建和查看。 文章资源的 URL 设计如下: - 获取所有文章:`GET /articles` - 获取指定 ID 的文章:`GET /articles/:id` - 创建文章:`POST /articles` - 更新指定 ID 的文章:`PUT /articles/:id` - 删除指定 ID 的文章:`DELETE /articles/:id` 评论资源的 URL 设计如下: - 获取指定文章的所有评论:`GET /articles/:article_id/comments` - 创建评论:`POST /articles/:article_id/comments` - 获取指定 ID 的评论:`GET /articles/:article_id/comments/:id` 在上述例子中,使用了路径参数和查询参数来表示资源的唯一标识符和对资源的操作。同时,HTTP 方法也清晰地表示了对资源的操作类型。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

静安书以沫

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值