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

RESTful API规范

时间:2022-11-18 23:11:30浏览次数:33  
标签:API baidu www api com 规范 books https RESTful

1.url链接一般都采用https协议进行传输

  http:数据明文传输

  https:数据加密传输 http + ssl

2.用api关键字标识接口url:

  https://api.baidu.com

  https://www.baidu.com/api/

3.在url链接中标识接口版本

  https://www.baidu.com/api/v1

  https://www.baidu.com/api/v2

4.数据即是资源,均使用名词(可复数)

  https://www.baidu.com/api/v1/books

5.资源操作由请求方式定义

  https://www.baidu.com/api/v1/books get请求:获取所有书

  https://www.baidu.com/api/v1/books/1 get请求:获取id 为1的一本书

  https://www.baidu.com/api/v1/books post请求:新增一本书

  https://www.baidu.com/api/v1/books/1 put请求:修改id为1的书

  https://www.baidu.com/api/v1/books/1 delete请求: 删除id为1的书

6.过滤,通过在url上传参的形式传递搜索条件

  https://www.baidu.com/api/v1/books?limit=10 : 指定返回记录的数量

  https://www.baidu.com/api/v1/books?offset=10:指定返回记录的开始位置

  https://www.baidu.com/api/v1/books?page=2&per_page=100:指定第几页,以及每页的记录数

  https://www.baidu.com/api/v1/books?sortby=name&order=asc:指定返回结构按照哪个属性排序,以及排序顺序

  https://www.baidu.com/api/v1/books?type_id=1:指定筛选条件

7.响应状态码

  200:常规请求(成功)

  201:创建成功

  301:永久重定向

  302:临时重定向

  403:请求无权限

  404:请求路径不存在

  405:请求方法不存在

  500:服务器异常

  业务状态码:可自定义,100001,100002...

8.错误处理,应返回错误信息,error当做key

  { error: "无权限操作!"}

9.返回结果,针对不同操作,服务器向用户返回的结果应该符合以下规范

  GET /books:返回资源对象的列表

  GET /books/1:返回单个资源对象

  POST /books:返回新生成的资源对象

  PUT /books:返回完整的资源对象

  DELETE /books/1:返回一个空文档

10.需要url请求的资源需要访问资源的请求链接

  

标签:API,baidu,www,api,com,规范,books,https,RESTful
From: https://www.cnblogs.com/wangdianchao/p/16901866.html

相关文章

  • Kubernetes集群配置APIServer公网访问
    内容纲要首先打开/etc/kubernetes/pki目录,里面会有很多证书。执行命令查看当前证书允许通过哪些地址访问APIServer:opensslx509-inapiserver.crt-noout-text|gre......
  • 自己制作一个bing每日图片API
    上代码 <?php$str=file_get_contents('http://cn.bing.com/HPImageArchive.aspx?idx=0&n=1');//从bing获取数据if(preg_match('/<url>([^<]+)<\/url>/isU'......
  • Git - 提交规范
    常用的规范<type>(<scope>):<subject><body><footer>type1、feat:提交新的功能,feature。2、fix:解决了bug。3、docs:修改的是文档相关的内容。4、style:格式修改......
  • 【API设计与开发实践】第2篇 Restful API 设计最佳实践的四个重要改进
    RestfulAPI设计最佳实践已经被讨论过多次,其中命名规则有共识也有差异。从函数实现的角度出发,基于简单、明确的原则,在考虑对接RPCAPI的情况下,可以发现一些冲突和理解上......
  • Android开发所需的Android SDK、开发中用到的工具、Android开发教程、Android设计规范
    https://www.androiddevtools.cn/ 一、下载SDKTools下载地址:https://www.androiddevtools.cn/   二、这里有exe和zip两种文件可供下载,exe的就是个安装程序,下载......
  • Zookeeper客户端命令以及API操作
    zookeeper实战一、zookeeper客户端命令1、zookeeper命令语法命令基本语法功能描述help显示所有操作命令lspath使用ls命令来查看当前znode的子节点【可监......
  • SQLSERVER调用WebAPI和WebService
    原文:https://blog.csdn.net/qq243348167/article/details/124243810第一步需开启组件开启组件sp_configure'showadvancedoptions',1;GORECONFIGURE;GOsp_confi......
  • Vue3, setup语法糖、Composition API全方位解读
    起初Vue3.0暴露变量必须return出来,template中才能使用;Vue3.2中只需要在script标签上加上setup属性,组件在编译的过程中代码运行的上下文是在setup()函数中,无......
  • iis 反向代理 API以及websocket
    前言:前端的系统一般不支持跨域,需要我们部署的时候配置下反向代理。这边介绍下iis反向代理,iis反向代理是通过iis的URL重写模块来重写URL从而访问目标服务器的。假设我们......
  • GO命名规范
    GO命名规范Go中命名规范主要分为两种:标识符:函数名,常量,变量等其他:模块,文件标识符命名为应当严格遵行规范,因为会影响到标识符的作为域.非标识符命名在......