spring----RESTful

最新推荐文章于 2024-04-21 19:43:41 发布

weixin_30920091

最新推荐文章于 2024-04-21 19:43:41 发布

阅读量114

点赞数

CC 4.0 BY-SA版权

文章标签： json web.xml java

原文链接：http://www.cnblogs.com/yanxiaoge/p/10974645.html

本文详细介绍了 RESTful API 的设计理念，包括资源路径、请求方法及响应格式，并通过 SpringMVC 和 SpringBoot 展示了如何在实际项目中应用 PUT 和 DELETE 方法。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

REST 是一种很笼统的概念，它代表一种架构风格。

api

加上版本号

http://localhost:8080/api/v1/list

一旦api接口确定，不在改变接口实现的业务逻辑

资源路径

URI 不能包含动词，只能是名词。注意的是，形容词也是可以使用的，但是尽量少用。一般来说，不论资源是单个还是多个，API 的名词要以复数进行命名。此外，命名名词的时候，要使用小写、数字及下划线来区分多个单词。这样的设计是为了与 json 对象及属性的命名方案保持一致

【GET】  /v1/tags/{tag_id}

有的时候，当一个资源变化难以使用标准的 RESTful API 来命名，可以考虑使用一些特殊的 actions 命名。

【PUT】  /v1/users/{user_id}/password/actions/modify // 密码修改

请求方式

可以通过 GET、 POST、 PUT、 PATCH、 DELETE 等方式对服务端的资源进行操作。其中：

GET：用于查询资源
POST：用于创建资源
PUT：用于更新服务端的资源的全部信息
PATCH：用于更新服务端的资源的部分信息
DELETE：用于删除服务端的资源。

响应参数

如果是单条数据，则返回一个对象的 JSON 字符串。

{
    "id" : "01234567-89ab-cdef-0123-456789abcdef",
    "name" : "example",
    "created_time": 1496676420000,
    "updated_time": 1496676420000,
    ...
}

如果是列表数据，则返回一个封装的结构体

{
    "count":100,
    "items":[
        {
            "id" : "01234567-89ab-cdef-0123-456789abcdef",
            "name" : "example",
            "created_time": 1496676420000,
            "updated_time": 1496676420000,
            ...
        },
        ...
    ]
}

SpringMVC处理Put或Delete

1、首先在web.xml中配置过滤器

<filter>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
</filter>
<filter-mapping>
        <filter-name>HiddenHttpMethodFilter</filter-name>
        <url-pattern>/*</url-pattern>
</filter-mapping>

2、form表单配置隐藏域，注意表单中method必须为post，隐藏域中name和value属性如下所示

<form action="/delete" method="post">
    <input name="_method" value="DELETE" type="hidden">
    <input type="submit" value="提交">
</form>

3、处理请求

需要加上@ResponseBody注解，否则报错，加上该注解后，就不能返回视图了

@RequestMapping(value = "/delete",method = RequestMethod.DELETE)
@ResponseBody
public String delete() throws IOException {
        return "delete";
}

Rest 风格 URL

左边是传统的api，右边是Rest风格的api

/get?id=1 ---->/order/1 get

/add ---->/order post

/delete?id=1 --->/order/1 delete

/update?id=1 --->/order/2 put

SpringBoot处理Put或Delete

1、配置 HiddenHttpMethodFilter（不需要了，SpringBoot已经配置好了）

2、form表单配置隐藏域

<form action="/delete" method="post">
    <input name="_method" value="DELETE" type="hidden">
    <input type="submit" value="提交">
</form>

转载于:https://www.cnblogs.com/yanxiaoge/p/10974645.html