zoukankan      html  css  js  c++  java
  • RESTful API 设计规范理解

    RESTful 是一种共识和 http里的URL 的规范。

    网站里  : 使用GET、POST的选择点在于,简单的用GET、复杂对象用POST

    REST里: GET对应的是查询一个资源,而POST对应的是新增一个资源

    例子:

    网站 get_user?id=3

    REST: GET /user/3 (GET是HTTP类型)

    RESTFul API 特点

    1. 使用HTTP动词表示增删改查资源, GET:查询,POST:新增,PUT:更新,DELETE:删除

    2. 返回结果必须使用JSON

    3. HTTP状态码,在REST中都有特定的意义:200,201,202,204,400,401,403,500。比如401表示用户身份认证失败,403表示你验证身份通过了,但这个资源你不能操作。

    4. 如果出现错误,返回一个错误码。比如我通常是这么定义的:

    1. API必须有版本的概念,v1,v2,v3
    2. 使用Token令牌来做用户身份的校验与权限分级,而不是Cookie。
    3. url中大小写不敏感,不要出现大写字母
    4. 使用 - 而不是使用 _ 做URL路径中字符串连接。
    5. 有一份漂亮的文档~(很重要)

    接口设计是一个非常依赖于经验和重构的技术活儿
    设计接口需要有一些艺术家的天赋
    你看GitHub的接口就非常的“美”,不要觉得很简单,真的比写代码还难。
    难道大家不觉得,有时候起名字真的是一件很难的事儿嘛?

  • 相关阅读:
    各种筛法与莫比乌斯反演
    欧拉函数技巧与学习笔记
    莫比乌斯函数与欧拉函数的单个值的快速求法
    最短路算法总结
    NOI2018网络同步赛游记
    中国剩余定理及其扩展学习笔记
    构造方法的格式
    private关键字
    成员变量和局部变量的区别
    数据加密代码实现
  • 原文地址:https://www.cnblogs.com/ajk4/p/12916738.html
Copyright © 2011-2022 走看看