• API接口规范


    对于资源的具体操作类型,由HTTP动词表示。

    常用的HTTP动词有下面四个(括号里是对应的SQL命令)。

    GET(SELECT):从服务器取出资源(一项或多项)。

    POST(CREATE):在服务器新建一个资源。

    PUT(UPDATE):在服务器更新资源(客户端提供改变后的完整资源)。

    DELETE(DELETE):从服务器删除资源。

    下面是一些例子。

    GET /product:列出所有商品

    POST /product:新建一个商品

    GET /product/ID:获取某个指定商品的信息

    PUT /product/ID:更新某个指定商品的信息

    DELETE /product/ID:删除某个商品

    GET /product/ID/purchase :列出某个指定商品的所有投资者

    get /product/ID/purchase/ID:获取某个指定商品的指定投资者信息

    API参数规范

    多api中,表示相同意义的参数的名称要保持相同。同理api的返回值也要确保相同意义的返回值使用相同的名称。

    例如:在创建商品与更新商品的两个API中都使用到了商品简介,则要确保使用的参数名称(product_desc)一致。

  • 相关阅读:
    第二周作业
    第一周作业
    抓老鼠啊~亏了还是赚了?
    打印沙漏
    寒假作业2
    我与老师
    自我介绍
    第九周课程总结&实验报告(七)
    第八周课程总结&实验报告(六)
    第七周实验报告(五)&周总结
  • 原文地址:https://www.cnblogs.com/xxoome/p/7766433.html
Copyright © 2020-2023  润新知