美文网首页
接口和API设计

接口和API设计

作者: jiezheng | 来源:发表于2017-04-04 16:25 被阅读0次

一.使用前缀避免命名空间冲突


!引用第三方库,同样需要进行添加项目前缀

二.提供全能初始化方法

!在类中提供全能初始化方法,并在文档中声明,所有初始化方法必须调用次方法。

!若全能初始化方法与父类不同,则需要重写父类的方法。

!若父类的全能初始化方法不适用时,应当重写,并抛出异常。

三.实现Description方法

!普通模式--重写description

!Debug模式--重写debugDescription

四.尽量使用不可变对象

!控制操作权限

!尽量创建不可变对象,并且不要公开不可变对象,提供相应的接口即可。

五.使用清晰而协调的命名方式

!遵循OC命名规则,简单易懂的描述该方法的功能。

!公开方法和私有方法加标记

六.减少使用异常抛出

!使用Error返回错误信息

相关文章

  • 接口和API设计

    1、用前缀避免命名空间冲突, 其中前缀一般为三个大写字母。不仅仅是类名,应用程序中的所有名称都应加前缀,包括分类、...

  • 接口和API设计

    一.使用前缀避免命名空间冲突 !引用第三方库,同样需要进行添加项目前缀 二.提供全能初始化方法 !在类中提供全能初...

  • API接口安全性设计

    API接口安全性设计 接口的安全性主要围绕Token、Timestamp和Sign三个机制展开设计,保证接口的数据...

  • RESTful api接口安全优雅设计

    RESTful api接口安全优雅设计 ...

  • api 接口设计

    包括两部分: 业务场景 如推荐、排行、搜索 元素item 如问题、作者、直播

  • API接口设计

    API - Application Programming Interface 语言本身提供的API网络API(数...

  • django中tastypie风格接口设计

    需求背景: 使用tastypie原则开发api接口,同时对前面设计的api做适当优化。 tastypie风格接口设...

  • Netty实战阅读笔记

    1.Netty的组件和设计 1.1 Channel接口 Netty的channel接口提供的api大大的降低了直接...

  • web-api总结

    总结一下ruby中如何写设计api接口: 1.api是程序之间的接口,一个服务端api接口包含http方法,URL...

  • RESTful API

    RESTful 是目前最流行的 API 设计规范,用于 Web 数据接口的设计。本文参考 《REST和RESTf...

网友评论

      本文标题:接口和API设计

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