zoukankan      html  css  js  c++  java
  • 编写REST API

    REST API规范
    编写REST API,实际上就是编写处理HTTP请求的async函数,不过,REST请求和普通的HTTP请求有几个特殊的地方:

    REST请求仍然是标准的HTTP请求,但是,除了GET请求外,POST、PUT等请求的body是JSON数据格式,请求的Content-Type为application/json;
    REST响应返回的结果是JSON数据格式,因此,响应的Content-Type也是application/json。
    REST规范定义了资源的通用访问格式,虽然它不是一个强制要求,但遵守该规范可以让人易于理解。

    例如,商品Product就是一种资源。获取所有Product的URL如下:

    GET /api/products
    而获取某个指定的Product,例如,id为123的Product,其URL如下:

    GET /api/products/123
    新建一个Product使用POST请求,JSON数据包含在body中,URL如下:

    POST /api/products
    更新一个Product使用PUT请求,例如,更新id为123的Product,其URL如下:

    PUT /api/products/123
    删除一个Product使用DELETE请求,例如,删除id为123的Product,其URL如下:

    DELETE /api/products/123
    资源还可以按层次组织。例如,获取某个Product的所有评论,使用:

    GET /api/products/123/reviews
    当我们只需要获取部分数据时,可通过参数限制返回的结果集,例如,返回第2页评论,每页10项,按时间排序:

    GET /api/products/123/reviews?page=2&size=10&sort=time

    请求 地址 说明
    get /messages 获取所有消息
    post /message 创建一个消息
    put /message 修改消息内容
    patch /message/text 修改消息的 text 字段
    get /message/id 根据 ID 获取消息
    delete /message/id 根据 ID 删除消息

  • 相关阅读:
    L347
    2019.4.22 英语阅读
    L345 大脑复生
    L343 中译英
    L342 Air Pollution Is Doing More Than Just Slowly Killing Us
    Is It Always a Good Idea to Reach Outside Your Comfort Zone?
    2019.4月 商务英语场景
    元器件横截面-这里有很多专业词汇
    python 列表和元组 还有range
    python 基本数据类型简介intstr bool
  • 原文地址:https://www.cnblogs.com/ysit/p/10749583.html
Copyright © 2011-2022 走看看