首页 > 其他分享 >Restful API规范

Restful API规范

时间:2023-01-03 17:45:00浏览次数:39  
标签:API www http students com 规范 api Restful zihoo

定义

restful ,全称为Representational State Transfer,翻译为中文叫做资源状态转换(表征性状态转移)。
Restful风格是一种专门为Web开发而定义API接口的设计风格,尤其适用于前后端分离的应用模式中。

  • 把服务端的所有的数据或文件都堪称资源,那么通过api接口请求数据的操作,本质上来说就是对资源的操作了。因此,restful中要求,我们把当前对外提供哪种资源进行操作,就把资源的名称写在url地址
  • web开发中操作资源,最常见的最通用的无非就是增删改查,所以restful要求在地址栏中声明要操作的资源是什么,然后通过http请求动词来说明对该资源进行哪一种操作。
// 添加学生数据
POST: http://www.zihoo.com/api/students
// 获取所有学生数据
GET:http://www.zihoo.com/api/students
// 删除id=pk的学生数据
DELETE:http://www.zihoo.com/api/students/<pk>/
// 修改id=pk的学生的全部信息
PUT:http://www.zihoo.com/api/students/<pk>/
// 修改id=pk的学生的部分信息
PATCH:http://www.zihoo.com/api/students/<pk>/

也就是说,我们仅需要通过url地址上的资源名称结合HTTP请求动作,就可以说明当前api接口的功能是什么了。
restful是以资源为主的api接口规范,体现在地址上就是资源,以名词来表达。

标签:API,www,http,students,com,规范,api,Restful,zihoo
From: https://www.cnblogs.com/Gazikel/p/17022690.html

相关文章

  • .net core WebApi 返回类型
         ......
  • vue3.0的全局api变化
    1.全局api使用的变化:vue3已经去除Vue语法,取代的是用createApp创建的app  2.其他改变2.1data函数的变化,在vue3data必须是一个函数,否则报错     2.2过......
  • SEO:在必应(bing)站长后台哪里获取到必应API?
    网站有时候需要用到主动推送API,关于必应的API需要在必应的后台获取,步骤如下:1.登录必应后台,点击“设置”>>>点击API访问  2.点击查看API密钥;  3.点击复制,即可获......
  • Web APIs 简介
    WebAPIs简介目录WebAPIs简介1.WebAPIs和JS基础关联性1.1JS的组成1.2JS基础阶段以及WebAPIs阶段2.API和WebAPI2.2WebAPI学习目标:WebAPIs和JS......
  • .net core WebApi 参数修饰特性(FromService、FromBody等)
     注:FromServices为IOC属性注入,参考:如何在ASP.NETCore中使用FromServices     ......
  • RESTful风格的Web服务框架:Swagger
    Swagger与SpringMVC项目整合为了方便的管理项目中API接口,在网上找了好多关于API接口管理的资料,感觉目前最流行的莫过于Swagger了,功能强大,UI界面漂亮,并且支持在线测试等等,所......
  • apidoc文档
    1、需求:需要根据api生成文档2、思路:目前看到node的两种解决方案apidoc和swagger,apidoc的原理是根据文件中的注释来生成文档,swagger是根据一个集合的json文件来生成文档,个......
  • roapi 基于datafusion+ apache arrow 的多协议api 平台
    roapi是基于datafusion+apachearrow的多协议api平台,基于rust开发参考架构  支持的特性多协议,graphql,restapi,pgsql基于datasusion的查询计划执行数据层......
  • drf快速使用 CBV源码分析 drf之APIView分析 drf之Request对象分析
    目录序列化和反序列化drf介绍和安装使用原生django写接口djangoDRF安装drf快速使用模型序列化类视图路由datagrip使用postman测试接口CBV源码分析drf之APIView分析View类......