• 如何设计一个restful风格的API


    1.API接口应该尽量兼容之前的版本,在URL上应保留版本号,并同时兼容多个版本

    2.每一个URI代表一个资源

    3.请求方式要与http请求方式一致,GET(获取),POST(新增),PUT(更新全部),PATCH(更新部分),DELETE(删除)

    4.应提供查询参数,如:limit,count,orderby,page

    5.状态码应和http状态码保持一致,2**(成功),3**(重定向),4**(客户端错误),5**(服务器错误)

    6.返回结果针对不同操作

    【GET】     /{version}/{resources}/{resource_id}      // 返回单个资源对象
    【GET】     /{version}/{resources}                    // 返回资源对象的列表
    【POST】    /{version}/{resources}                    // 返回新生成的资源对象
    【PUT】     /{version}/{resources}/{resource_id}      // 返回完整的资源对象
    【PATCH】   /{version}/{resources}/{resource_id}      // 返回完整的资源对象
  • 相关阅读:
    pyhanlp 实体命名识别
    NABCD需求分析
    源代码
    遇到的问题和解决方法
    运行及总结
    测试与调试
    读《一个程序猿的生命周期》和《人,绩效和职业道德》有感
    面向对象程序设计
    设计类图
    SRS文档
  • 原文地址:https://www.cnblogs.com/ldq1996/p/9786246.html
Copyright © 2020-2023  润新知