开发移动应用时,如何制定API?

1 确定基本项目:

命名规范(容易忽视的项目是版本号,漏掉会带来升级维护的困难),

是否需要保持状态(建议不保持),

使用什么做数据交换(建议 JSON ),

是否需要使用 gzip https 等(建议使用),

认证如何做

等等。

(参考: google RESTful 风格 )

2 确定客户端和服务器的交互方式:

是否需要分页,

是否需要 Lazy loading ,

异步提交等等。

(很重要,而且和需求紧密相关。技术人员一定要和产品人员沟通好。

这些都可能影响你的 API 设计。)

3 设计功能 API:

根据 1,2 ,你可以明确而且写出每个画面对应的所有 API。

4 抽象和合并:

把这些 API 重新抽象,是否需要增加通用 API ?是否可以合并 API ? API 是否需要分层?

有现有系统?那么如何和现有 Web 服务连接?

(很重要。可以有效降低风险,减少成本)

5 排除负荷风险:

对于可以预测的高负荷 API /大运算量 API 做优化。

(设计和技术两方面。不要等到测出效率问题再考虑,那时候余地就有限了。

办法很多,但是也很容易爆掉预算。事先做好预案和沟通总是没错的。)

6 安排优先级

项目管理的内容,不多说。

7 编写测试代码:

编写好所有的接口,然后准备测试代码。(参考:google TDD 模式)

建议 github 找一个真正的项目结合上面的内容看。

作者:李楠

链接:https://www.zhihu.com/question/20797114/answer/16224873

相关推荐