博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
RESTful API 规范
阅读量:7294 次
发布时间:2019-06-30

本文共 897 字,大约阅读时间需要 2 分钟。

首先 RESTful 是一种软件架构风格或者说是一种设计风格,并不是标准,它只是提供了一组设计原则和约束条件,主要用于客户端和服务器交互类的软件。

一、协议

  在 url 接口中推荐使用 Https 协议,让网络接口更加安全。(简单讲是 Http 的安全版。即 Http 下加入SSL层,Https 的安全基础是 SSL,因此加密的详细内容就需要SSL)

二、接口

  在 url 中可以体现这是个 API 接口。

https://127.0.0.1:8000/api/

三、版本

  在 url 中可以体现版本号。

https://127.0.0.1:8000/api/v1/

四、路径

  在 RESTful 架构中,每个网址代表一种资源(resource),所以网址中不能有动词,只能有名词,而且所用的名词往往与数据库的表格名对应。一般来说,数据库中的表都是同种记录的"集合"(collection),所以 API 中的名词也应该使用复数。

http://127.0.0.1:8000/api/v1/courses/
http://127.0.0.1:8000/api/v1/course/1/

五、筛选

  如果数据数量很多,服务器不可能都将它们返回给用户。API 应该提供参数,过滤返回结果。

?page=2

六、状态码

  服务器应向用户返回状态码和提示信息。

七、错误处理

  如果发生错误,就应该向用户返回出错信息。

{"code": 1000, "error": "用户名或密码错误!"}

八、请求方式

  可以根据 Http 不同的请求 method,进行不同的资源操作。(GET、POST、PUT、PATCH、DELETE)

九、Hypermedia API

  RESTful API 最好做到 Hypermedia,即返回结果中提供链接,连向其他 API 方法。

十、其他

  服务器返回的数据格式,应该尽量使用JSON,避免使用XML。

转载于:https://www.cnblogs.com/believepd/p/10256319.html

你可能感兴趣的文章
cmake是什么
查看>>
使用MASM10(变量的使用)- Win32汇编语言018
查看>>
【Docker学习笔记】----基于centos 7 的Docker安装
查看>>
Android笔记之OnLongClickListener
查看>>
Java客户端:调用EyeKey HTTP接口进行人脸对比
查看>>
SQL之分区函数
查看>>
创业公司如何实施敏捷开发
查看>>
Django使用AJAX调用自己写的API接口
查看>>
数据科学求职准备
查看>>
Wireshark抓包工具使用教程以及常用抓包规则
查看>>
fedora16下更改网卡名字
查看>>
awk中NF,NR的含义
查看>>
Centos下Docker中运行neo4j 并配置挂载本地文件
查看>>
静态页面跳转传值小插件
查看>>
JetBrains公司的IDE使用技巧
查看>>
第三届中国云计算用户大会笔记和心得
查看>>
PHP7开启opcache打造强悍性能
查看>>
加载某个页面(A)时实现自动跳转到某个页面(B)
查看>>
Jenkins入门系列之——03PDF文档下载
查看>>
Digit Generator(生成元)
查看>>