专栏首页搬砖记录【经验分享】RESTFul实践以及数据库字段兼容设计与字段预留

【经验分享】RESTFul实践以及数据库字段兼容设计与字段预留

1. RESTFul与API设计

RESTFul是一种架构设计风格,它有多个实现层级,最常用的领域在于前后端交互时的API设计。 API一般有两层含义:一是指语言或者框架的使用方法(如JAVA API文档),描述了语言或框架的函数调用接口;而是指远程调用的接口地址。

RESTFul有两个最大的特征:面向资源操作以及无状态,本次分享只涉及到面向资源操作。

RESTFul将请求抽象为资源操作,比如我们百度搜索“学习”,其实是在向百度服务器中的 “学习”【资源的查询】操作。

资源基本操作包含四种:【查询】、【添加】、【删除】、【修改】,分别对应HTTP方法的【get】、【POST】、【DELETE】、【PUT】(其实这个并非RESTFul规定的,而是实践中最常用的模式)。

但是,实际上,“将请求抽象为资源操作”有时候并不好使用。比如如下两个接口设计: POST www.baidu.com/login POST www.baidu.com/user-access-token

第一个一看就是登陆的接口,而第二个表示增加一个user-acces-token资源,隐含意思就是登陆(当我们登陆时,增加了一个登录凭证)

RESTFul不允许在地址中写动词,但是很多具体的动作抽象成资源,本身具有一定的难度,而且可读性较差。

实际当中,包含动作的接口非常多,并不仅仅限于基本的增删改查,要求将复杂的动作都归结到简单的增删改查上面,但是每个人对这些动作的理解可能不一样,这就导致最终抽象的资源难以理解。 尽管RESTFul看起来十分火热,然而真正完全遵循它的大厂基本没有,RESTFul最佳实践的GitHub,也是用了动词的 。

最常用的是混搭风格:动作+资源抽象。 保留【查询】、【添加】、【删除】、【修改】,分别对应HTTP方法的【get】、【POST】、【DELETE】、【PUT】。 保留动词。

用户操作: 查询: GET /user/get/1 注册: POST /user/register 登录: POST /user/login 删除: DELETE /user/remove/1 批量查询: POST /user/list

2. 数据库字段兼容设计与字段预留

主键ID:如果没有自增逻辑,使用varchar(方便分布式) 时间:使用时间戳 long 价格:使用decimal,保留两位小数。不要使用Double ,float ;java里面BigDecimal 状态、布尔值、性别等:用0、1、2、3…表示的值,如果没有构建字典表,不要使用数字,直接用真值。类型用char。 类型:使用char,不考虑动态扩展类型时不要增加type表,在服务端使用枚举。

字段预留:图片、备注、新增时间、修改时间、被谁新增、被谁修改、状态、逻辑删除

mysql时间戳的使用 https://www.cnblogs.com/orac/p/6433874.html

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • 人人都是 API 设计者:我对 RESTful API、GraphQL、RPC API 的思考

    有一段时间没怎么写文章了,今天提笔写一篇自己对 API 设计的思考。首先,为什么写这个话题呢?其一,我阅读了《阿里研究员谷朴:API 设计最佳实践的思考》一文后...

    用户2781897
  • Koa2+MongoDB+JWT实战--Restful API最佳实践

    Web API 已经在最近几年变成重要的话题,一个干净的 API 设计对于后端系统是非常重要的。

    前端森林
  • GitHub 标星 5w+!Python 新手 100 天学习计划,这次再学不会算我输!

    作为目前最火也是最实用的编程语言,Python 不仅是新手入门程序界的首选,也逐渐成为了从大厂到小厂,招牌需求 list 的必要一条。

    GitHubDaily
  • GraphQL 浅谈,从理解 Graph 开始

    前言 GraphQL is a data query language developed internally by Facebook in 2012 bef...

    企鹅号小编
  • 干货 | 万字长文全面解析GraphQL,携程微服务背景下的前后端数据交互方案

    古映杰,携程研发高级经理,负责前端框架和基础设施的设计、研发与维护。开源项目react-lite和react-imvc作者。

    携程技术
  • CloudBase CMS 2.0 焕新升级,从「心」出发!

    ? CloudBase CMS 是一个基于云开发 + Node + React 构建的 Headless CMS 系统。不久前,我们开源发布了 CloudBa...

    腾讯云开发TCB
  • GraphQL-BFF:微服务背景下的前后端数据交互方案

    随着多终端、多平台、多业务形态、多技术选型等各方面的发展,前后端的数据交互,日益复杂。

    五月君
  • GraphQL-BFF:微服务背景下的前后端数据交互方案

    随着多终端、多平台、多业务形态、多技术选型等各方面的发展,前后端的数据交互,日益复杂。

    Nealyang
  • 超媒体:将客户端服务端分离进行到底

    2017 年年末,就职小米的一位前同事送了我一枚 F 码,我用它抢购到一枚小爱音箱。我满怀期待地装上“小爱同学”,希望能够通过她用语音控制所有小米产品。但我失望...

    用户1682855
  • Github标星过万,Python新手100天学习计划,这次再学不会算我输!

    作为目前最火也是最实用的编程语言,Python不仅是新手入门程序界的首选,也逐渐成为了从大厂到小厂,招牌需求list的必要一条。

    磐创AI
  • GitHub 标星 5w+!Python 新手 100 天学习计划,这次再学不会算我输!

    说明:我最近整理了一份Python基础系列文章,如果你是Python新手或者你的Python基础知识点忘记了,可以看看今日第三条文章。

    龙哥
  • 腾讯技术分享:社交网络图片的带宽压缩技术演进之路

    腾讯社交网络相关产品,例如腾讯课堂、增值会员、动漫、直播、游戏商城、音乐、Qzone校园等,主要目标群体定位为年轻一代,属于对新事物接受比较高也更喜欢新鲜个性内...

    JackJiang
  • 为什么我使用 GraphQL 而放弃 REST API?

    本文最初发布于 Max Desiatov 的个人博客,经原作者授权由 InfoQ 中文站翻译并分享。

    winty
  • 2020-5-6-restful理解

    Restful已经是目前我们耳熟能详的概念了,但是找了下网上的文章,大部分都是介绍restful API范式。很少介绍resetful架构的。今天同大家介绍下对...

    黄腾霄
  • 课程 |《深度学习原理与TensorFlow实践》学习笔记(二)

    作者 | 王清 TensorFlow基础使用 环境准备 TensorFlow安装 常用Python库介绍 实例解析 Kaggle平台及Titanic题目介绍 代...

    AI科技大本营
  • 初识 Kubernetes API 的组织结构

    话说自己入坑云原生也有好几年了,但是对 kubernetes 基础认识却不够深,导致写代码的时候经常需要打开 godoc 或者 kubernetes 源码查看某...

    米开朗基杨
  • GraphQL[0x01] -- GraphQL基础实践

    GraphQL 既是一种用于 API 的查询语言也是一个满足你数据查询的运行时。它由Facebook开发和开源,强烈地表达了代码即文档的期望。能够精确有效地得到...

    winty
  • GraphQL[0x01] -- GraphQL基础实践

    GraphQL 既是一种用于 API 的查询语言也是一个满足你数据查询的运行时。它由Facebook开发和开源,强烈地表达了代码即文档的期望。能够精确有效地得到...

    江涛同志
  • 我遇到的前端面试题分享

    前端安全问题主要有XSS、CSRF攻击 XSS:跨站脚本攻击 它允许用户将恶意代码植入到提供给其他用户使用的页面中,可以简单的理解为一种javascript代码...

    疯狂的技术宅

扫码关注云+社区

领取腾讯云代金券