# js-sapi

**Repository Path**: gridsoft/js-sapi

## Basic Information

- **Project Name**: js-sapi
- **Description**: 一款简单的数据库rest接口工具
- **Primary Language**: JavaScript
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-12
- **Last Updated**: 2024-02-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# js-sapi 标准接口js版

## 接口传参语法

|功能   | 前端传参   |
|---|---|
|=字符=   | ==   |
|包含      |"name": "%rose%"   |
|开始于    |"name": "rose%"     |
|结束于    |"name": "%rose"      |
|=数值和日期=   | ==   |
|大于     | "age": ">18"         |
|小于   |   "age": "<=18"        |
|范围    |  "age": [18, 20]    |
|多段范围    |  "age": ["18, 20", "30, 35"]    |
|=通用=   | ==   |
|等于      |"name": "rose"       |
|IN      |"name": "rose, tom" |
|FIND_IN_SET  |"name": "set=rose, tom" |
|不等于    |"name": "!=rose"      |
|正则      |"name": "/^[0-9]+$/"   |
|空        |"name": "NULL"       |
|非空      | "name": "! NULL"     |
|=排序=   | ==   |
|排序      |"@order": "name+, age-, id"     |

## 数据库建表默认字段

|字段名 |字段类型 | 说明
|---|---|---|
| id |  bigint unsigned  | 自增
|created_at |timestamp | 创建时间
|updated_at | timestamp |更新时间
|deleted_at | timestamp |删除时间
|created_by | bigint | 创建人id
|updated_by | bigint | 更新人id
|deleted_by | bigint | 删除人id
|is_deleted | bigint unsigned | 是否删除 默认 0 ，删除复制id值，便于索引
|remark | string | 备注

## 需求

* [ ] 字段参数校验
* [ ] 字段 mask

## 参考项目

受以下项目启发：

* apijson
* postgREST