在很多情况下,在开发REST API(或尝试使用这种模式)时,我们并不重视建立干净,可理解且可扩展的体系结构的重要性,但从长远来看,随着应用程序的增长,这将产生巨大影响。
假设现在是时候向用户公开我们正在开发的界面了,那么您如何确定他们了解您尝试在界面中传输的内容呢?对使用该应用程序的用户的理解不仅是相关的,而且对于您的团队和将来将要使用该应用程序的人们来说也是可以理解的。从架构的开始就建立一个每个人都会尊重的基础是至关重要的。
这些是我认为最重要的几个方面:
1.使用HTTP方法赋予端点含义
REST API鼓励我们对应用程序的每个CRUD操作使用HTTP方法。其中,我们有以下几种:GET,POST,PUT,DELETE和PATCH。与资源关联的端点的名称必须带有与所应用的动作有关的HTTP方法。
- GET /get_cats
- POST /insert_cats
- PUT /modify_cats
- DELETE /delete_cats
+ GET /cats
+ POST /cats
+ PUT /cats
+ DELETE /cats
2.状态代码必须符合我们API的结果。
我们应用程序最重要的品质之一就是端点的返回与相应的状态码有关。这意味着一旦我们的结果成功或失败,我们就可以以更具描述性的方式关联我们想要传达的信息。
例如,如果我们获得状态200,则可以立即知道我们的结果是成功的;否则,如果我们获得状态400,则结果将失败。
重要的是要知道现有的状态码,并知道我们需要在每种情况下应用它们,因为返回消息可能会错误地与某些状态码相关联(这很常见),这对于正常工作非常有害。应用程序,因为它会使我们的REST API的开发人员和消费者用户感到困惑。