当前位置：首页 > 文章列表 > 数据库 > MySQL > xmysql: 一行命令从任何mysql数据库生成REST API

xmysql: 一行命令从任何mysql数据库生成REST API

来源：SegmentFault 2023-01-26 12:58:03 0浏览收藏

在数据库实战开发的过程中，我们经常会遇到一些这样那样的问题，然后要卡好半天，等问题解决了才发现原来一些细节知识点还是没有掌握好。今天golang学习网就整理分享《xmysql: 一行命令从任何mysql数据库生成REST API》，聊聊MySQL、javascript、npm、rest-api、restfull，希望可以帮助到正在努力赚钱的你。

github向我推荐这个xmysql时候，我瞟了一眼它的简介

One command to generate REST APIs for any MySql Database

, 说实话这个介绍让我眼前一亮，想想每次向后端的同学要个接口的时候，他们总是要

哼哧哼哧

搞个半天给才能我。抱着试试看的心态，我试用了一个疗程，oh不是，是安装并使用了一下。说实话，体验是蛮不错的，但是体验一把过后，我想不到这个工具的使用场景，因为

你不可能把数据库的所有表都公开出来，让前端随意读写,

但是试试看总是不错的.

1 来吧，冒险一次！

安装与使用

npm install -g xmysql

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

浏览器打开：http://localhost:3000， 应该可以看到一堆json

2 特点

产生REST Api从任何mysql 数据库 ??
无论主键，外键，表等的命名规则如何，都提供API ??
支持复合主键 ??
REST API通常使用：CRUD，List，FindOne，Count，Exists，Distinct

批量插入，批量删除，批量读取 ?

关联表
翻页
排序
按字段过滤 ?
行过滤 ?
综合功能
Group By, Having (as query params) ??
Group By, Having (as a separate API) ??
Multiple group by in one API ????
Chart API for numeric column ??????
Auto Chart API - (a gift for lazy while prototyping) ??????
XJOIN - (Supports any number of JOINS) ?????????
Supports views
Prototyping (features available when using local MySql server only)
Run dynamic queries ???
Upload single file
Upload multiple files
Download file

3 API 概览

HTTP Type	API URL	Comments
GET	/	Gets all REST APIs
GET	/api/tableName	Lists rows of table
POST	/api/tableName	Create a new row
PUT	/api/tableName	Replaces existing row with new row
POST	/api/tableName/bulk	Create multiple rows - send object array in request body
GET	/api/tableName/bulk	Lists multiple rows - /api/tableName/bulk?_ids=1,2,3
DELETE	/api/tableName/bulk	Deletes multiple rows - /api/tableName/bulk?_ids=1,2,3
GET	/api/tableName/:id	Retrieves a row by primary key
PATCH	/api/tableName/:id	Updates row element by primary key
DELETE	/api/tableName/:id	Delete a row by primary key
GET	/api/tableName/findOne	Works as list but gets single record matching criteria
GET	/api/tableName/count	Count number of rows in a table
GET	/api/tableName/distinct	Distinct row(s) in table - /api/tableName/distinct?_fields=col1
GET	/api/tableName/:id/exists	True or false whether a row exists or not
GET	/api/parentTable/:id/childTable	Get list of child table rows with parent table foreign key
GET	/api/tableName/aggregate	Aggregate results of numeric column(s)
GET	/api/tableName/groupby	Group by results of column(s)
GET	/api/tableName/ugroupby	Multiple group by results using one call
GET	/api/tableName/chart	Numeric column distribution based on (min,max,step) or(step array) or (automagic)
GET	/api/tableName/autochart	Same as Chart but identifies which are numeric column automatically - gift for lazy while prototyping
GET	/api/xjoin	handles join
GET	/dynamic	execute dynamic mysql statements with params
GET	/upload	upload single file
GET	/uploads	upload multiple files
GET	/download	download a file
GET	/api/tableName/describe	describe each table for its columns
GET	/api/tables	get all tables in database

3 更多资料

项目地址：https://github.com/o1lab/xmysql

";s:4:"tags";a:5:{i:0;s:16:"1040000000090688";i:1;s:16:"1040000006048152";i:2;s:16:"1040000000607648";i:3;s:16:"1040000000089436";i:4;s:16:"1040000000089439";}}

今天带大家了解了MySQL、javascript、npm、rest-api、restfull的相关知识，希望对你有所帮助；关于数据库的技术知识我们会一点点深入介绍，欢迎大家关注golang学习网公众号，一起学习编程~

mysql MySQL javascript npm

版本声明

本文转载于：SegmentFault 如有侵犯，请联系study_golang@163.com删除