网商之窗
 
当前位置: 首页 » 资讯网 » 互联网 » 正文

博娱联盟-从App角度看API设计

放大字体  缩小字体 发布日期:2019-10-09 14:50  来源:1396bo  作者:博娱  浏览次数:2
核心提示:做了10多年的桌面和逻辑模块的开发,两年前才开始接触互联网这一块,说起来对RESTful API是没有太多经验的。公司app搭建之初,前后端通力合作,期间同不少后端同事就API的设计都有过沟通交流;到现在app上线也要快满一年了,不久前进行了一次大改版,部分API
 做了10多年的桌面和逻辑模块的开发,两年前才开始接触互联网这一块,说起来对RESTful API是没有太多经验的。

公司app搭建之初,前后端通力合作,期间同不少后端同事就API的设计都有过沟通交流;到现在app上线也要快满一年了,不久前进行了一次大改版,部分API也从v1升级到了v2,觉得有些经验,可以总结一下。

一. API设计的一些基本原则——博娱1396bo

API是自述的

大多数我看的资料所写的Intuitive(直观的、直觉可理解的),也有些写Deive(描述xing的),我将其命名为“自述”。一个API有自述xing,也就是说看到API的URL,就知道这个API是要干嘛;且这个API的返回值中的字段,又能很好的解释其返回的内容。

虽然API文档是不可或缺的,但是如果看到API的URL和API的返回值字段就知道这个API的功能作用,多好!

(注:下文有实例)

API是完备的

对于一组API,我们会要求其为最小完备集。

对于一个API,个人觉得其同样有最小完备xing。这里我主要是指在各种输入参数情况下,API的返回都应该是合理的、完全的。(实际工作中我发现为了满足各种不同的需求,有时候API的返回值中会插入一下冗余信息,因此我这里只提完备xing。)

(注:下文有实例)

API是抽象的

在软件工程中,一直都有各式各样的Add a Layer of Indirection,即通过一层抽象,屏蔽掉具体的数据/实现/细节。使用领域和表现形式各异,其原理实则相同。

 
 

 
相关资讯