版权声明:本文为博主原创文章,未经博主允许不得转载。 https://blog.csdn.net/jzm1963173402/article/details/82528451
一、一些与REST API 相关的重要术语
- 资源(Resource)是一个对象或对某物的表示。它有一些相关联的数据,并有一组方法进行操作。 例如:动物,学校和员工是资源。 这些资源都有着删除,添加,更新,查询操作。
- 集合(Collection)是一系列资源,例如:公司集合是很多公司的集合。
- URL (统一资源定位符) 是一种路径,可以通过它定位资源并且也可以对它执行一些动作。
二、API端点(路径)
- 每个URL代表一种资源(Resourse), 所以URL中只能有名词,不能有动词。 API路径/addNewEmployee 包含了操作addNew和资源名称Employee.
- 资源 在API端点中应该总是复数,如果我们想访问资源的一个实例,我们可以传递URL中的id.
- URL 是一个句子,其中资源的名词,HTTP方法是动词
4.主要的HTTP方法如下
- GET 方法从资源请求数据,不产生多余结果。例如:/companies/3/employees 会返回公司3的所有雇员列表。
- POST 方法请求服务器在数据库中创建资源,这主要用于提交web表单时。例如:/companies/3/empolyees 创建一个公司3的新雇员 POST是非幂等的,这意味着多个请求将会有不同的效果。
- PUT 方法请求服务器更新资源或创建资源(如果不存在) 例如:/companies/3/employees/john 将请求服务器在公司3的雇员集合中更新或在不存在的情况下创建关于john的资源。 PUT 是幂等的,这意味着多次请求具有相同的效果。
- DELETE 方法将请求的资源或实例从数据库中删除
例如:/companies/3/employees/john/ 将请求服务器从公司3的雇员集中删除john资源。
三、HTTP 响应状态码