api规范PHP,RESTfulAPI规范（详细版）
rest
是⼀种软件架构风格，如果你们的接⼝是 rest
接⼝，那么就可被认为你们的的接⼝是restful的，英⽂名词和形容词的区别。
rest
接⼝是围绕“资源”展开的，利⽤HTTP的协议，其实rest本也可以和HTTP⽆关，但是现在⼤家普遍的使⽤ rest
都是依托于HTTP协议。HTTP 的url即资源。
RFC 3986
定义了通⽤的URI语法：
URI = scheme “://” authority “/” path [ “?” query ][ “#” fragment ]
scheme: 指底层⽤的协议，如http、https、ftp
restful接口设计
host: 服务器的IP地址或者域名
port: 端⼝，http中默认80
path: 访问资源的路径，就是咱们各种web 框架中定义的route路由
query: 为发送给服务器的参数
fragment: 锚点，定位到页⾯的资源，锚点为资源id
RESTful API设计
资源路径
对于rest资源的定义，即URL的定义，是最重要的；想要设计出优雅的、易读的rest 接⼝，其实还是听不容易的。
URL中不能有动词
在Restful架构中，每个⽹址代表的是⼀种资源，所以⽹址中不能有动词，只能有名词，动词由HTTP的 get、post、put、delete 四种⽅法来表⽰。
URL结尾不应该包含斜杠“/”
这是作为URL路径中处理中最重要的规则之⼀，正斜杠(/)不会增加语义值，且可能导致混淆。REST API不允许⼀个尾部的斜杠，不应该将它们包含在提供给客户端的链接的结尾处。
许多Web组件和框架将平等对待以下两个URI：
但是，实际上URI中的每个字符都会计⼊资源的唯⼀⾝份的识别中。
两个不同的URI映射到两个不同的资源。如果URI不同，那么资源也是如此，反之亦然。因此，REST API必须⽣成和传递精确的URI，不能容忍任何的客户端尝试不精确的资源定位。
有些API碰到这种情况，可能设计为让客户端重定向到相应没有尾斜杠的URI(也有可能会返回301 – ⽤来资源重定向)。
正斜杠分隔符”/“必须⽤来指⽰层级关系
rul的路径中的正斜杠“/“字符⽤于指⽰资源之间的层次关系。
例如：
应该使⽤连字符”-“来提⾼URL的可读性，⽽不是使⽤下划线”_”
为了使URL容易让⼈们理解，请使⽤连字符”-“字符来提⾼长路径中名称的可读性。
⼀些⽂本查看器为了区分强调URI，常常会在URI下加上下划线。这样下划线”_”字符可能被⽂本查看器中默认的下划线部分地遮蔽或完全隐藏。
为避免这种混淆，请使⽤连字符”-“⽽不是下划线
URL路径中⾸选⼩写字母
RFC 3986将URI定义为区分⼤⼩写，但scheme 和 host components除外。
URL路径名词均为复数
为了保证url格式的⼀致性，建议使⽤复数形式。
RESTful API对资源的操作
对于rest api资源的操作，由HTTP动词表⽰
CURD操作
GET: 获取资源
POST：新建资源
PUT：在服务器更新资源(向客户端提供改变后的所有资源)
PATCH: 在服务器更新资源(向客户端提供改变的属性)
DELETE：删除资源
PATCH
⼀般不⽤，⽤ PUT
资源过滤
在获取资源的时候，有可能需要获取某些“过滤”后的资源，例如指定前10⾏数据
返回状态码推荐标准HTTP状态码
有很多服务器将返回状态码⼀直设为200，然后在返回body⾥⾯⾃定义⼀些状态码来表⽰服务器返回结
果的状态码。由于rest api是直接使⽤的HTTP协议，所以它的状态码也要尽量使⽤HTTP协议的状态码。
200 OK 服务器返回⽤户请求的数据，该操作是幂等的
201 CREATED 新建或者修改数据成功
204 NOT CONTENT 删除数据成功
400 BAD REQUEST ⽤户发出的请求有问题，该操作是幂等的
401 Unauthoried 表⽰⽤户没有认证，⽆法进⾏操作
403 Forbidden ⽤户访问是被禁⽌的
422 Unprocesable Entity 当创建⼀个对象时，发⽣⼀个验证错误
500 INTERNAL SERVER ERROR 服务器内部错误，⽤户将⽆法判断发出的请求是否成功
503 Service Unavailable 服务不可⽤状态，多半是因为服务器问题，例如CPU占⽤率⼤，等.

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。