xmysql:可为MySql生成REST API的神奇命令

翻译 2017年11月08日 16:46:56

原文:xmysql: one command to generate REST APIs for any MySql database
作者:o1lab
翻译:Vincent

为什么用这个命令?

为MySql数据库快速生成REST API,而且还不遵循诸如rails、django等框架的约定,这可能是一种不太受欢迎的冒险行为。



但是也正因为如此。

该命令的功能都是由node packages提供支持的:(express, mysql) => { xmysql }

安装与用法

npm install -g xmysql

xmysql -h localhost -u mysqlUsername -p mysqlPassword -d databaseName

http://localhost:3000

这样就可以了。

特点

  • 只要是MySql数据库,就都可以生成API
  • 无论主键,外键,表等的命名约定如何,均可提供API
  • 增删改查:日常操作
  • 支持复合主键
  • 分页
  • 排序
  • 字段
  • 关系表
  • 可运行动态查询

可以使用像Postman 或者类似的HTTP客户端工具来调用REST API。

如果你的系统上面还没有这些的话,请先下载nodemysqlsetup mysql),示例数据库

根路径

直接访问根路径(localhost:3000/)会返回每张表中schema的所有REST API。

CRUD APIs 日常操作

  • GET /api/:tableName
  • POST /api/:tableName
  • GET /api/:tableName/:id
  • PUT /api/:tableName/:id
  • GET /api/:tableName/count
  • GET /api/:tableName/exists
  • GET /api/:parentTable/:id/:childTable
  • DELETE /api/:tableName/:id
  • POST /dynamic

其它的API

  • GET /api/:tableName/describe
  • GET /api/tables

支持复合主键

_(三个下划线)

/api/payments/103___JM555205

_:如果有多个主键 - 如图所示,用三个下划线分隔就可以了

分页

_p & _size

前者表示分多少页,后者表示响应行的大小。

默认情况下,每张表上面的GET请求会返回20条记录,最多100条。

/api/payments?_size=50

/api/payments?_p=2

/api/payments?_p=2&_size=50

排序

_sort
/api/payments?_sort=column1

上述命令表示按column1升序排列

/api/payments?_sort=-column1

上述命令表示按column1降序排列

/api/payments?_sort=column1,-column2

上述命令表示按column1升序排列,再按column2降序排列

字段

/api/payments?_fields=customerNumber,checkNumber

上述命令表示只得到每条记录的customerNumber和checkNumber这两个字段

/api/payments?_fields=-checkNumber

上述命令表示获取每行记录中除checkNumber以外的所有字段

运行动态查询

在数据库上面可以通过将方法POST到localhost:3000/dynamic该URL上面就可以运行动态查询了。

这仅支持-h localhost或-h 127.0.0.1选项中才能启用。

Post的body里面有两个字段:query和params。

query:SQL查询或SQL prepared查询(带??和?的)

params:SQL prepared查询的参数

POST /dynamic   

{
    "query": "select * from ?? limit 1,20",
    "params": ["customers"]
}

关系表

xmysql自动识别外键关系并提供GET api。

/api/customers/103/payments

例如:Customers是父表,payments是子表。API调用将会返回103号客户的所有付款记录。

什么时候应该使用

  • 只需要REST API,而不需要任何麻烦的MySql数据库。
  • 正在学习新的前端框架,而且MySql数据库需要使用REST API。
  • 正在做demo或者黑客等工作

什么时候不该不用

  • 如果需要的是一个完整的MVC框架,ACL,授权等等——而并不是这个。
  • 在”什么时候应该使用”章节里面没有提到的场景都不要用

相关文章推荐

为MySql生成REST API命令

该命令的功能都是由node packages提供支持的:(express, mysql) => { xmysql } 安装与用法 npm install -g xmysql xmysql...

利用CURL命令调用WebHDFS REST API与Kerberos机制

1. CURL安装 cURL是一个利用URL语法在命令行下工作的文件传输工具,1997年首次发行。它支持文件上传和下载,所以是综合传输工具,但按传统,习惯称cURL为下载工具。cURL还包含了用于程...

Swagger生成Rest API

之前写了一篇Swagger生成API文档的文章,在后来应用过程中发现应用的版本不对,后来进行了调整,由于最近3个都非常的忙,一直到今天才更新:import org.springframework.co...
  • sreng
  • sreng
  • 2017年03月27日 15:01
  • 1101

为REST API添加自动化文档生成能力

当前,作为大部分移动app和云服务后台之间的标准连接方式,REST API已经得到了绝大部分开发者的认可和广泛的应用。近年来,在新兴API经济模式逐渐兴起,许多厂商纷纷将自己的后台业务能力作为REST...

使用apidoc自动生成rest风格api接口文档

1 先下载安装nodejs,下载地址: 点击打开链接 2 安装apidoc,命令行执行: npm install apidoc -g 安装完成后执行: apidoc --help 检验一下是...

使用Swagger,Swagger-UI生成REST API接口文档

Swagger,Swagger-UI是什么?Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和 文件系统作为服务器以同样的...

SpringBoot&Swagger构建REST API并生成API文档

概述 开始 注解说明 运行效果 API文档访问与调试概述通常我们要构建API 服务,自然少不了文档,但由于API与文档的分离使得我们每次对API进行的更改都需要再去修改文档后同步文档,不但编写稳定繁琐...
  • zjcjava
  • zjcjava
  • 2017年04月19日 18:36
  • 2588

JIRA REST API汇总

  • 2017年10月11日 17:01
  • 235KB
  • 下载

REST API Design Rulebook

  • 2017年10月12日 01:04
  • 5.05MB
  • 下载
内容举报
返回顶部
收藏助手
不良信息举报
您举报文章:xmysql:可为MySql生成REST API的神奇命令
举报原因:
原因补充:

(最多只允许输入30个字)