首页 > 其他分享 >RESTful API详解

RESTful API详解

时间:2022-10-27 19:11:43浏览次数:42  
标签:www URL RESTful API https test com 详解

简述

  REST ful API是符合REST风格的webAPI,REST是一种设计风格。全称是REpresentational State Transfer,中文叫表述性状态转移。

  用一句话来说,RESTful API就是:

  用URL定位资源,用HTTP动词描述操作

RESTful API的好处

  规范API设计

  增强API的可读性

  方便前后端协作

路径规范

路径只有名词

  URL中只能有名词(资源名),不能有动词,名词一般与数据库表名相对应

  例如:https://www.test.com/users

  而不是:https://www.test.com/addUsers

  动作体现在HTTP请求的类型上,例如我们用get请求访问 https://www.test.com/users 就包含了获取用户的含义

名词用复数

  资源名应该使用复数形式,使用users而不是user

资源ID放URL上

  资源ID应该作为路径的一部分,紧跟在资源后

  例如:https://www.test.com/users/1 

  而不是:https://www.test.com/users?id=1

  注意仅限id,查询参数请不要放在URL上

父资源应该在子资源前面

  如果users是父资源,accouts是子资源

  例如:https://www.test.com/users/1/accouts/3

  而不是:https://www.test.com/accouts/1/user/3

其他规范

  URL中统一使用小写字母

  使用 "-" 代替 "_"

  URL中不能包含文件的扩展名

  URL结尾不要包含 "/"

交互设计

  即使用不同HTTP请求方式代表增删改查的功能  

  GET——查

  POST——增

  DELETE——删

  PUT,PATCH——改

HATEOAS

  HATEOAS是比较高端的REST ful 设计风格,指在HTTP的返回数据中link其他可能需要动作的信息

  Hypermedia as the Engine of Application State(超媒体作为应用状态的引擎)

标签:www,URL,RESTful,API,https,test,com,详解
From: https://www.cnblogs.com/CNLayton/p/16828249.html

相关文章

  • 万物皆可集成系列:低代码对接阿里物流API实现快递跟踪
    随着各大电商网购平台的发展,快递业已形成一个规模庞大的产业,据统计,全球快递企业已超过千家,而快递查询对于电商平台而言是最基础的功能之一,通过输入快递单号,不用区分具体是哪......
  • Vue3 Composition API
    一、响应式基础前提:你会使用setup函数或<scriptsetup>语法1.reactive我们可以使用reactive()函数创建一个响应式对象或数组:import{reactive}from'vue'c......
  • #打卡不停更#三方库移植之NAPI开发[3]通过IDE开发NAPI工程
    在三方库移植之NAPI开发[1]—HelloOpenHarmonyNAPI一文中,笔者开发的是一个rom包的napi工程。该工程需要编译烧录固件,C++的动态库会集成到开发板的ROM中。在本篇文章中,......
  • 【计算机视觉(CV)】基于高层API实现宝石分类
    【计算机视觉(CV)】基于高层API实现宝石分类作者简介:在校大学生一枚,华为云享专家,阿里云专家博主,腾云先锋(TDP)成员,云曦智划项目总负责人,全国高等学校计算机教学与产业实践资......
  • 090_索引和文档的API操作
    目录注入RestHighLevelClient关于索引的API操作创建索引判断索引是否存在删除索引关于文档的API操作创建实体类添加文档判断文档是否存在获取文档更新文档删除文档大批量文......
  • SSM中使用RESTful风格开发
    RESTful请求方式查询:GET添加/保存:POST删除:DELET修改:PUT SSM查询使用RESTful风格无参请求一般用于查询全部(selectAll)//设置当前请求方法为GET,表示......
  • .NET Core WebApi 快速切换开发/生产环境
    项目结构中有三个配置文件  appsettings.json:通用配置文件appsettings.Development.json:开发环境配置文件appsettings.Production.json:生产环境配置文......
  • 微信小程序之获取定位api忽然失效解决方法
    这个问题困扰了我一整天才解决,一定要写篇文章记录下,下面先讲讲遇到问题后的思路。测试提出bug:小程序获取位置信息失败了,也不会弹出授权弹框,然后我在想之前明明是好的,......
  • 如何使用递归,递归使用的技巧详解
    弄明白递归什么是递归编写递归的技巧递归的缺点来几个栗子1、斐波那契数列2、兔子繁衍问题3、青蛙跳台阶问题4、汉诺塔问题5、二叉树的遍历总结参考......
  • unique_ptr使用详解(介绍,场景,方法,实例)
    1.什么是uniqueptruniqueptr是智能指针的一种,主要用于C++的内存申请和释放,因为C++在申请内存后,要手动进行delete,这样就会出现有时候忘记delete,或者return,break,异常等原因......