restful风格接口

本文介绍了RESTful接口的设计理念,通过对比传统接口与RESTful接口的区别,展示了如何利用HTTP方法(GET, POST, PUT, DELETE)来实现不同的操作。在RESTful风格下,URL更加简洁,请求方式明确区分了查询、创建、更新和删除操作,提高了接口的可读性和易维护性。
摘要由CSDN通过智能技术生成

普通接口

    @RequestMapping(value = "deleteUser")
    public String deleteUserNoRest(){
        return "delete user";
    }

上面是我们一般的接口写法,如果接口很多,会造成命名困扰。比如增删改查就要分别命名getUser,deleteUser,saveUser,updateUser。

restful接口

1.网络上的所有事物都被抽象为资源
2.每个资源都有一个唯一的资源标识符
3.同一个资源具有多种表现形式(xml,json等)
4.对资源的各种操作不会改变资源标识符
5.所有的操作都是无状态的
直接看代码:

    @RequestMapping(value = "user",method = RequestMethod.DELETE)
    public String deleteUser(){
        return "delete user";
    }

可以看到,我接口的名字是user,但是请求方式变成了delete。
我们再写一个接口:

    @RequestMapping(value = "user",method = RequestMethod.PUT)
    public String putUser(){
        return "put";
    }

可以看到,这两个接口的名字都是user,但是接口返回的数据却不一样。
我们起动项目试试:
使用delete为请求方式时:
在这里插入图片描述
使用put为请求方式时:
在这里插入图片描述
可以看出虽然url一样,但是请求方式不同,最后结果不一样,说明请求方式不同,他就会调用不同接口。
总结一下就是这样:
在Restful之前的操作:
http://127.0.0.1/user/query/1 GET 根据用户id查询用户数据
http://127.0.0.1/user/save POST 新增用户
http://127.0.0.1/user/update POST 修改用户信息
http://127.0.0.1/user/delete/1 GET/POST 删除用户信息

RESTful用法:
http://127.0.0.1/user/1 GET 根据用户id查询用户数据
http://127.0.0.1/user POST 新增用户
http://127.0.0.1/user PUT 修改用户信息
http://127.0.0.1/user DELETE 删除用户信息

### 回答1: RESTful风格接口通常会使用多个单词来描述其功能和目的,例如“get-user-info”表示获取用户信息的接口。在展示这些接口时,通常会使用下划线或中划线来将多个单词连接起来,例如“get_user_info”或“get-user-info”。这种方式可以让接口名称更加清晰明了,便于理解和使用。 例如,一个用于获取用户信息的RESTful风格接口可以这样展示: - get_user_info - get-user-info ### 回答2: 在RESTful风格接口中,如果需要将多个单词拼接起来,可以使用以下几种方式进行展示: 1. 使用驼峰命名法(Camel Case):这种命名方式将各个单词首字母大写,并将它们连在一起,例如:getUserInfo。这种命名方式简洁明了,容易读写,适用于较短且语义明确的资源路径。 2. 使用下划线(Underscore)连接:这种命名方式将各个单词用下划线连接起来,例如:get_user_info。这种命名方式可读性较好,适用于较长或复杂的资源路径。 3. 使用中划线(Dash)连接:这种命名方式将各个单词用中划线连接起来,例如:get-user-info。这种命名方式在URL中较为常见,可读性较好,适用于较长或复杂的资源路径。 无论使用哪种方式进行拼接,关键是保证命名的语义明确,易读易写。另外,建议在URL中使用小写字母,以避免大小写敏感的问题。例如,使用getUserInfo而不是GetUserInfo。 综上所述,RESTful风格接口中多个单词拼接起来的展示方式可以选择驼峰命名法、下划线连接或中划线连接,关键是要保证易读易写和语义明确。 ### 回答3: 在RESTful风格接口中,如果是多个单词拼接起来,可以使用以下方法来展示。 1. 采用短横线连接:可以将多个单词之间使用短横线连接起来。例如,如果要表示获取用户信息的接口,可以将其命名为“/users-info”。 2. 采用下划线连接:也可以将多个单词之间使用下划线连接起来。例如,如果要表示获取用户信息的接口,可以将其命名为“/users_info”。 3. 采用驼峰命名法:可以使用驼峰命名法,将每个单词的首字母大写,并将它们连接在一起。例如,如果要表示获取用户信息的接口,可以将其命名为“/usersInfo”。 4. 采用路径参数:另一种常见的方式是使用路径参数来表示接口。例如,如果要表示获取某个用户的信息,可以将其命名为“/users/{userId}/info”。其中,{userId}是一个路径参数,用于表示具体的用户ID。 无论采用哪种方式,都需要确保接口的命名清晰且易于理解。一般建议遵循约定俗成的命名规范,并与团队一起制定和遵循统一的命名规则,以便在开发、维护和使用接口时能够更加方便和高效。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值