我正在寻找一种方法来在我的基于PHP的Web应用程序,数据库和CMS中围绕默认函数包装API.
我环顾四周,发现了几个"骨架"框架.除了我的问题的答案,还有Tonic,我喜欢的REST框架,因为它非常轻量级.
我最喜欢REST,因为它简单,并且希望基于它创建一个API架构.我试图了解基本原则并且还没有完全理解它.因此,一些问题.
我理解对吗?
假设我有一个资源"用户".我可以像这样设置一些URI:
/api/users when called with GET, lists users
/api/users when called with POST, creates user record
/api/users/1 when called with GET, shows user record
when called with PUT, updates user record
when called with DELETE, deletes user record
Run Code Online (Sandbox Code Playgroud)
到目前为止,这是RESTful架构的正确表示吗?
我需要更多的动词
理论上创建,更新和删除可能就足够了,但在实践中我需要更多的动词.我意识到这些内容可以嵌入到更新请求中,但它们是具有特定返回代码的特定操作,我不想将它们全部放入一个操作中.
用户示例中的一些想法是:
activate_login
deactivate_login
change_password
add_credit
Run Code Online (Sandbox Code Playgroud)
我将如何表达RESTful URL架构中的操作?
我的直觉是对像这样的URL进行GET调用
/api/users/1/activate_login
Run Code Online (Sandbox Code Playgroud)
并期望返回状态代码.
但是,这偏离了使用HTTP动词的想法.你怎么看?
3.如何返回错误消息和代码
REST的美丽很大一部分源于其使用标准HTTP方法.如果出错,我会发出一个包含3xx,4xx或5xx错误状态代码的标头.对于详细的错误描述,我可以使用正文(对吗?).到现在为止还挺好.但是,传输专有错误代码的方法是什么,该错误代码在描述错误时更详细(例如"无法连接到数据库"或"数据库登录错误")?如果我把它和信息一起放入体内,我必须在事后解析它.这种东西有标准的标题吗?
4.如何进行身份验证
我正在开发一个 RESTful API。我对在这种特殊情况下设置 HTTP 状态代码感到困惑。我不确定我(服务器)应该返回什么状态代码。
假设我的应用程序具有关注用户功能,如果我已经关注用户并再次发送相同用户 ID 的关注请求,那么在这种情况下,来自服务器的 HTTP 状态代码应该是什么。状态代码后会出现一条错误消息,内容类似于:“已经关注用户”。
对于取消关注用户功能,可以考虑类似的情况,如果我没有关注用户“A”,我仍然向取消关注用户“A”发送请求,那么服务器应该返回什么 HTTP 状态代码并带有类似“不关注用户”之类的错误消息取消关注”
肯定 200 响应代码在这里对我来说似乎不合适?还是呢?
如果我在错误的堆栈交换站点上发布了问题,请原谅我,我将其发布在 stackoverflow 站点中只是因为它与 REST API 相关。
编辑
从客户端用户需要向 URL 发送 POST 请求:
http://www.myserver.com/api/follow/10
Run Code Online (Sandbox Code Playgroud)
以及在服务器端提供请求之前用于身份验证的其他必要参数(如 API 密钥、正确的标头等)。
取消关注操作的类似 URL 是:
http://www.myserver.com/api/unfollow/10
Run Code Online (Sandbox Code Playgroud)
现在,如果客户端发送关注请求,我将发送 HTTP 状态代码 200 作为响应,假设用户 ID 为 10,即使他/她已经关注 ID 为 10 的用户。在这种情况下,连同状态代码(200 ) 我正在发送类似于“已关注用户”的消息
不知何故,我觉得这并不令人信服,因为没有创建/更新资源,它应该返回带有正确状态代码的错误消息,而不是 200,可能是 4XX 中的一个,不确定。