RESTFul API最佳实践

 

SOAP   VS    REST

SOAP
    重
    采用XML表述数据
    
REST
    轻
    采用JSON表述数据
    无状态
    (链接打开数据库，然后查询新增，还要关闭数据库，不是无状态。无状态是你每次请求都会拿到你的结果)

TESTFul API
    基于资源，增删改查都只是对于资源状态的改变
    使用HTTP动词来操作资源

    使用URL表示资源    尽量避免使用动词，推荐使用名词
    HTTP动词  GET  POST  使用哪个取决于是查询还是新增操作
        错误示范  /getmovie/:mid
        正确示范  GET:/movie/:mid
        POST: 创建
        PUT: 更新
        GET: 查询
        DELETE: 删除

RESTFul API最佳实践
    状态码：404、400、200、201、202、401、403、500
    错误码：自定义的错误ID号
    统一描述错误：错误吗、错误信息、当前URL

    使用Token令牌来授权和验证身份
    版本控制    v1.banner(就是之前v1文件夹)
    测试与生产环境分开：api.xxx.com
                      dev.api.xxx.com

    URL语义要明确，最好可以"望文知意"
    最好是有一份比较标准的文档

模仿REST
    豆瓣API文档        GitHub文档
    RESTFul API的合理使用(切勿盲目照搬标准REST)