美文网首页
“真实世界”全栈开发-2.1-API的总体设计

“真实世界”全栈开发-2.1-API的总体设计

作者: 桥头堡2015 | 来源:发表于2018-02-04 09:50 被阅读18次

直观、一致、全面而简洁的API是好的网络应用不可或缺的部分。这一讲将简单描述本应用API的设计,同时会论及相关的基本原则和最佳实践。

API的设计

API设计的大原则是:应该以所需要实现的功能为中心,以方便使用而不是方便开发为目标。

API的设计一般有两个步骤:

  1. 明确统一的数据格式、命名规范、状态码(status code)、错误信息,等等
  2. 遵照上一步的规定,设计直观好用的端点(endpoint)

该应用最终有如下选择:

  • 数据格式使用JSON
  • 端点风格使用RESTful
  • 用户验证使用JWT(JSON Web Token)

完整的API设计见此页面。接下来的几篇将会对它进行较为详细的解释。

相关文章

网友评论

      本文标题:“真实世界”全栈开发-2.1-API的总体设计

      本文链接:https://www.haomeiwen.com/subject/ndfmzxtx.html