REST API设计步骤

2015-12-13 17:06:31

看了RESTful WEB APIs,做了些总结。


REST API的设计大概要经过7个步骤: 
1)根据业务模型,确定所有组成部分,比如各种语义描述符 
2)初步绘制状态转移图,每次变化中还不用急着指明用哪个协议方法。只要标明变化是安全的(比如HTTP GET),还是不安全/非幂等的(比如HTTP.POST),或者不安全/幂等的(PUT)。 
3)调和魔法字符串:将描述符适配为更公用的名字 
4)选择媒体类型:选定CS通讯采用的媒体格式,比如JSON 
5)生成语义文档,可以用swagger。 
6)code 
7)发布——包括文本档案、教程等

不过,上述过程通常用于提供公共服务的API开发。对于APP开发,可以将一些步骤去掉,比如说3)和7)。 
1)根据业务需求,确定语义描述符 
2)状态图 
3)选取通讯协议 
4)生成语义档案,并前后端共享(类似发布) 
5)code 
其中4)5)两步之间可以构建mockserver,以免前后端开发速度受到短板制约。