美文网首页
一般api设计使用基本原则

一般api设计使用基本原则

作者: freebell | 来源:发表于2017-03-20 22:05 被阅读0次

1.在相同的模块中,严禁在回调中使用该模块除了get语意的接口,尤其是close,stop之类的action接口除非底层做了相应处理。不能使用该属性通知而又通过get该属性,原则上面,该接口可能是无效的。

2.要区分reset,flush和Finish的语意场景,原则上调用了reset之后,所有的接口get类的接口都不可以再调用,直到重新初始化或者set接口之后,往往用于实时环境,需要快速返回的情况。而flush的接口往往在使用在确保之前的接口都应该将数据或者状态传递到最后一个知情者。Finish而使用者在确保所有的接口行为都已经执行完成。因此熟悉这类的接口将有助于理解以及设计相应的接口。偏于沟通理解,防止误用。

3.接口应该成双成对出现,比如open与close,play和stop,一个完备的软件体系必须从起点出发,也有相应的途径返回到相应的起点。

4.接口的设计语意功能应该适度,最好可以用一句言简意赅的陈述该接口的意义,另外需要考虑上层该接口的使用场景。

5.接口设计应该可以多层次化。一个好的接口设计体系即可以非常方便实现通用的功能,也能满足特定的场合使用。在这个情况下,接口多层次化也可以清晰展现给上层开发人员。

6.所有的接口都应该有返回值,除了对相应对象最后的销毁方法可以用void类型,也应该提倡用void类型,另外,上层需要判断每个接口是否操作正确。

7.所有的接口设计功能要保持单一明确,接口名要规范,接口直接需要保持适度的冗余与一致。

大概的经验之谈。

相关文章

  • 一般api设计使用基本原则

    1.在相同的模块中,严禁在回调中使用该模块除了get语意的接口,尤其是close,stop之类的action接口除...

  • 什么是Restful API

    Restful API与传统API设计区别: 1、不使用url参数:传统API设计:/api/list?pageI...

  • API设计规范

    设计前必读 整体规范建议使用 RESTful 风格 API 设计人员需要熟悉前端业务逻辑 API 文档使用自动化工...

  • python黑魔法---迭代器(iterator)

    因为Python,我见识了优雅。优雅不经在于自己使用,还在于如何设计API给别人使用。 设计 api 的时候,可以...

  • Flask使用合集

    使用 Python 和 Flask 设计 RESTful API

  • API 设计的基本原则

    1、分层: 高层API要为业务服务,贴近服务:业务可以是一个真实的业务系统,也可是一个分布式存储系统 总之。好的业...

  • API 设计随谈

    思考角度 api 使用者往往只关注,简单好用,越好用的api,越是感受不到它良好的设计存在。自然无感 api 设计...

  • Java 8的API设计原则

    掌握的Java API 8设计,才能确保客户端代码可以使用lambda表达式访问API。 一个好的API的设计需要...

  • iOS设计模式简介

    编码是门艺术 设计模式的基本原则 设计模式的类型 设计模式一般应用于复杂的项目 为什么会抽象出设计模式?设计模式是...

  • WebAPI设计之WebAPI

    什么是 Web API 在《Web API 的设计与开发》一书中,将 Web API 定义为使用 HTTP 协议通...

网友评论

      本文标题:一般api设计使用基本原则

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