用于CRUD等的模型驱动REST或GraphQL API

最新推荐文章于 2024-04-02 17:15:01 发布
最新推荐文章于 2024-04-02 17:15:01 发布
阅读量212 收藏
点赞数
分类专栏： web前端 文章标签： GraphQL REST javascript nodejs
原文链接：https://www.codeproject.com/Articles/1169060/Model-driven-REST-or-GraphQL-API-for-CRUD-and-More
版权

介绍

本文介绍了用于CRUD（创建、读取、更新、删除）的模型驱动REST或GraphQL API。有了它，您可以编写简单的模型（指定数据库表和要公开的列集），CRUD的REST端点将自动可用。不需要任何SQL的手动编码。

这个概念可以在不同的技术栈和语言上实现。在这里，我将JavaScript（生成SQL）与Node.js、Express和PostgreSQL结合使用。

背景

大多数项目需要Create、Read、Update和Delete对象。当这些对象足够简单时（一个驱动表和数据库中的几列），代码从一个对象到另一个对象非常相似。实际上，模式是相同的，唯一的区别是表的名称和列的名称和类型。

当然，总会有复杂的端点需要手工编写，但通过自动化简单的端点，我们可以节省大量时间。

使用代码

示例数据库为待办事项列表、地址簿和图画小说库存提供了三个示例。这些示例使用模型中指定的对象ID“todo”、“contact”和“comics”。

使用它们之后，更改数据库（在config.js中），更改模型（在模型目录中），RESTful API将根据您的数据结构进行更改。

按照以下步骤使用示例数据库安装和设置项目。

安装

从GitHub下载或克隆。

# To get the latest stable version, use git from the command line.
git clone https://github.com/evoluteur/evolutility-server-node

或使用npm包：

# To get the latest stable version, use npm from the command line.
npm install evolutility-server-node

设置

安装Evolutility-Server-Node后，请执行以下步骤：

  1. 创建一个PostgreSQL数据库。
  2. 在文件config.js中，设置PostgreSQL连接字符串和模式名称以访问您的新数据库。
  3. 在命令行中，键入以下内容：

# Install dependencies
npm install

# Create sample database w/ demo tables
node js/setup/database.js

# Run the node.js server
npm start

在Web浏览器中，转到URL http://localhost:3000/api/v1/evolutility/todo。

配置

在根目录下，编辑文件“config.js”来设置数据库连接和其他选项，如分页和上传目录。

Models

要由REST API访问，必须在模型中描述每个数据库表。模型包含驱动表的名称和API中存在的字段/列的列表。

实体

财产

意义

id

标识实体的唯一键（用作API参数）

table

数据库表名

fields

字段数组

titleField

记录标题的字段ID

searchFields

用于执行搜索的字段的字段ID数组

字段

财产

意义

id

字段的唯一键（可以与列相同，但不一定）

column

字段的数据库列名称

lovtable

字段值要加入的表（仅适用于“lov”类型的字段）

lovcolumn

字段值的列名（在lovtable中）（仅适用于“lov”类型的字段）

type

字段类型不是数据库列类型，而是UI字段类型。可能的字段类型：

  • boolean（是/否）
  • date
  • datetime
  • decimal
  • document
  • email
  • image
  • integer
  • lov（值列表）
  • money
  • text
  • textmultiline
  • time
  • url

readonly

防止字段修改

inMany

确定字段是否存在于记录列表中（默认情况下）

注意：更多字段属性（unique, min, max, minLength, maxLength...）将在稍后添加。

示例模型

这是一个待办事项应用程序的模型。

module.exports = {
    id: "todo",
    table: "task",
    titleField: "title",
    searchFields: ["title", "duedate", "description"],
    fields: [
        {
            id: "title", 
            column: "title", 
            type: "text", 
            inMany: true
        },
        {
            id: "duedate", 
            column: "duedate", 
            type: "date", 
            inMany: true
        },
        {
            id: "category", 
            column: "category_id", 
            type: "lov", 
            lovtable: "task_category",
            inMany: true
        },
        {
            id: "priority", 
            column: "priority_id", 
            type: "lov", 
            lovtable: "task_priority", 
            required: true, 
            inMany: true
        {
            id: "complete", 
            column: "complete", 
            type: "boolean", 
            inMany: true
        },
        {
            id: "description",  
            column: "description", 
            type: "textmultiline"
        }
    ]
};

此模型仅涵盖后端。也可以对前端进行建模（只要UX模式足够简单或者变得复杂到不值得）。

REST API

Evolutility-Server-Node的API受到PostgREST的极大启发（甚至部分复制），PostgREST也提供通用CRUD，但直接检查数据库模式而不是使用模型。

在本地运行项目时，“todo”应用程序的URL是http://localhost:3000/api/v1/evolutility/todo。

请求的信息

得到一个

要通过ID获取特定记录，请使用“< ObjectName >/ID”。

GET /<object>/<id>

GET /todo/12

获得许多

每个模型都暴露出来。您可以使用模型ID查询项目列表。

GET /<object>

GET /todo

过滤

您可以通过在字段上添加条件来过滤结果行，每个条件都是一个查询字符串参数。

GET /<object>/<field.id>=<operator>.<value>

GET /todo?title=sw.a
GET /todo?priority=in.1,2,3

添加多个参数结合条件：

todo?complete=0&duedate=lt.2017-01-01

这些运算符可用的：

操作符

意义

例子

eq

等于

/todo?category=eq.1

gt

比...更大

/todo?duedate=gt.2017-01-15

lt

少于

/todo?duedate=lt.2017-01-15

gte

大于或等于

/todo?duedate=gte.2017-01-15

lte

小于或等于

/todo?duedate=lte.2017-01-15

ct

包含

/todo?title=ct.e

sw

从...开始

/todo?title=sw.a

fw

以…结束

/todo?title=fw.z

in

值列表之一

/todo?priority=in.1,2,3

0

是假的

/todo?complete=0

1

是真的

/todo?complete=1

null

是null

/todo?category=null

nn

不是null

/todo?category==nn

排序

保留字“order”对响应行重新排序。它使用逗号分隔的字段和方向列表：

GET /<object>?order=<field.id>.<asc/desc>

GET /todo?order=priority.desc,title.asc

如果没有指定方向，则默认为升序：

GET /todo?order=duedate

限制和分页

保留字“page”和“pageSize”限制了响应行。

GET /<object>?page=<pageindex>&pageSize=<pagesize>

GET /todo?page=0&pageSize=50

格式化

默认情况下，所有API都以JSON格式返回数据。此API调用允许以CSV格式请求数据（导出到Excel）。此功能使用express-csv。

GET /<object>?format=csv

GET /todo?format=csv

注意：在返回的数据中，每个对象都有一个额外的属性“_full_count”，表示查询中的记录总数（限制之前）。

更新数据

记录创建

要在数据库表中创建一行，请发布一个JSON对象，其键是您要创建的列的名称。缺少的键将在适用时设置为默认值。

POST /todo
{ title: 'Finish testing', priority: 2}

更新

PATCH /todo
{ title: 'Finish testing', priority: 2}

删除

只需使用带有记录id的动词DELETE即可删除。

DELETE /<object>/<id>

DELETE /todo/5

附加端点

除了CRUD，Evolutility-Server-Node还为常见的UI需求提供端点，例如图表和值列表。

发现

返回对象及其API的列表（仅包括标记为活动的对象）。

GET /

注意：必须在配置中使用{apiInfo: true}启用此端点。

图表

对于图表数据，可以获得聚合数据。

GET /<object>/chart/<field id>

GET /todo/chart/category

值列表

UI中的下拉字段（在模型中的field.type="lov"）有一个REST端点来获取下拉列表的值。

GET /<object>/lov/<field id>

GET /todo/lov/category

统计数据

返回模型中数值字段的总数以及最小值、最大值、平均值和总计。

GET /<object>/stats

GET /todo/stats

上传文件

此端点允许您上传文件。当前（幼稚）实现仅将文件服务器上的文件保存在名为对象id的文件夹中。

POST /<object>/upload/<id>

POST /comics/upload/5

带有查询参数：file和“fieldid”。

嵌套集合

如果模型定义了集合，则可以使用此端点查询它们。

GET /<model.id>/collec/<collection.id>?id=<id>

GET /winecellar/collec/wine_tasting?id=1</code>

API版本

此端点获取API版本（在项目的package.json文件中指定）。

GET /version

GraphQL

Evolutility-Server-Node提供基于与REST API相同模型的GraphQL接口。

在本地运行项目时，garphiQL的URL是http://localhost:2000/graphql。

请求的信息

按ID获取一条记录

通过Id获取单个记录。

{ 
    contact (id: 1 ){
        firstname
        lastname
        category_txt
        email
  }
}

获得许多记录

所有对象都暴露给带有搜索和过滤器的查询。过滤器使用与REST API相同 的条件语法 （例如：{ firstname: "sw.A"} 表示“名字以“A”开头）。

“lov”（值列表）类型的字段表示为Id和值的2个字段。

{ 
	urgent_tasks: todos ( complete: "false", priority: "lt.3" ){
	    title
	    description
	    priority
	    priority_txt
	    category
	    category_txt
	    complete
  }
  	ab_a_contacts: contacts (search: "ab", firstname: "sw.A") { 
	    id
	    firstname
	    lastname
	    category_txt
	    email
  }
}

图表数据

对于所有对象，记录可以按字段聚合和计数（对于数字或“lov”类型的字段）。

{ 
  contacts_by_category: contact_charts(fieldId:"category"){
    label 
    value
  }
  task_by_priority: todo_charts(fieldId:"priority") {
    label 
    value
  }
  restaurants_by_cuisine: restaurant_charts(fieldId:"cuisine") {
    label 
    value
  }
}

兴趣点

模型驱动架构(MDA)将使您更快地启动和运行，同时也节省您在项目的进化维护中的时间。

例如，当项目完成时，我们经常需要添加字段。通常，这意味着向数据库添加一列，并在每个使用数据库表的REST端点中手动添加该字段。使用模型驱动的方法，一旦将列添加到数据库中，您只需将字段添加到单个位置（模型），并且使用该模型的每个端点都会公开它。

模型驱动的方法也可以应用于UI。如果你想玩它，我做了两个不同的匹配模型驱动UI的实现，Evolutility-UI-React（用于React）和Evolutility-UI-jQuery（用于jQuery和BackboneJS）。

https://www.codeproject.com/Articles/1169060/Model-driven-REST-or-GraphQL-API-for-CRUD-and-More

寒冰屋
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SOAP 和 REST 的区别
API
08-11 4626
很多人在软件开发中会分不清 SOAP 和 REST 方式，今天就来浅谈一下两者之间的区别。 通俗理解 通俗的来说，互联网时代，通信变得更加简单了，只要有网络就可以实现通信。通信需要遵循的一个规则就是协议。Rest 和 Soap 我们可以理解为信件和明信片，它们是建立在 Http 协议的通信方式。 Soap 是建立在 Http 之下的一种软件程序之间的通讯协议， 信封 Rest 是一种规范，主流的 Web API ，核心就是资源，一个资源可以就是被标识的实体，有具体的名称和地址。 邮票 Soap 主
evolutility-server-node：用于CRUD等的模型驱动的REST或GraphQL后端，使用Node.js，Express和PostgreSQL用Javascript编写
01-29
使用Node.js，Express和PostgreSQLCRUD等模型驱动的REST或GraphQL后端。 Evolutility-Server-Node为CRUD（创建，读取，更新，删除）和简单图表提供了一组通用或端点。 对于匹配的模型驱动的Web UI，请使用或 。 ...
crud-graphql-example
03-08
使用TypeORM构建出色的项目 运行该项目的步骤： 运行npm i命令 在ormconfig.json文件中设置数据库设置 运行npm start命令
SpringBoot 2 超媒体驱动 RESTful Web 服务
stevenchen1989的博客
02-04 823
开篇词 该指南将引导你使用 Spring 创建 “Hello, World” 超媒体驱动的 REST Web 服务。 超媒体是 REST 的重要体现。它使我们可以构建将客户端和服务器在很大程度上分离并使其独立发展的服务。为 REST 资源返回的展示形式不仅包含数据，而且还包含与相关资源的链接。因此，展示的设计对于整体服务的设计至关重要。   你将创建的应用 我们将使用 Spring HA...
opencrud graphql 数据操作指南
weixin_34128411的博客
08-08 69
opencrud 是社区团队提出，同时prisma框架就是按照这个标准设计的，里面包含了对于graphql 数据 操作的最佳实践，目前还在完善中，但是设计以及指南覆盖的功能还是比较全的，如果用过 prisma框架的人 应该会感觉非常熟悉，当前基于graphql 的框架工具是越来越多了，这个可以方便的指导我们开发基于graphql 的应用 参考资料 https://www.open...
graphql-java的CRUD及关联查询
热门推荐
feiqinbushizheng的博客
08-28 1万+
一、graphql基本语法： https://graphql.cn/learn/queries/#variables 二、graphql-java（graphql java客户端）： demo：https://blog.csdn.net/tangyaya8/article/details/105328461 扩展：数据关联 author对象下存在fans（一对多关联） 创建fans对象 @Entity @Data public class Fans { /** * 主键 */
evolutility-ui-react:使用REST或GraphQL的CRUD的模型驱动的Web UI
05-10
Evolutility-UI-React· Evolutility-UI-React是一组模型驱动的视图，用于，，，，，和。 有了它，您可以通过编写模型而不是代码来轻松构建CRUD应用程序。 它与REST API（使用 ）或GraphQL（使用 ）一起使用。 无需...
nodejs-the-complete-guide-academind:掌握Node JS和Deno.js，使用Node.js，GraphQL API构建REST API，添加身份验证，使用MongoDB，SQL等！
03-27
- **MongoDB**：了解NoSQL数据库，特别是MongoDB的文档型数据模型，学习Mongoose库用于连接和操作MongoDB，包括CRUD操作、聚合框架和数据模型设计。 - **SQL数据库**：探讨如何与MySQL或PostgreSQL等SQL数据库集成...
REST-API-节点-js
02-09
- `REST-API-Node-js-main`很可能包含了项目的主要文件，如`index.js`（启动文件）、`app.js`（Express应用）、`database.js`（数据库连接配置）、`models`目录（数据模型）、`routes`目录（路由定义）等。...
Koa-GraphQL-MongoDB-API：由Koa，MongoDB（MLAB）和GraphQL支持的API。 数据由诸如Javascript框架和库之类的技术组成
02-03
接下来，**GraphQL** 是Facebook开源的一种查询语言，用于API，旨在解决传统REST API中的一些问题，如过度获取和不足获取数据。GraphQL允许客户端定义所需的数据结构，从而减少网络通信的开销，提高数据获取效率。在...
GraphQL-node:Node＆GraphQL中的简单CRUD用户
04-11
GraphQL是API的查询语言，是用于使用现有数据来完成这些查询的运行时。 GraphQL为您的API中的数据提供了完整且易于理解的描述，使客户能够准确地询问他们需要什么，仅此而已，使随着时间的推移更容易开发API，并启用了功能强大的开发人员工具。 范例 CriaçãodoUsuário Listagem dosUsuários
graphql-server-crud:不使用样板代码构建GraphQL CRUD API服务器
03-08
请访问 ，以获取完整的文档。 介绍 这是一个轻量级的javascript框架/库，可帮助您有效地构建GraphQL服务器。 它旨在减小代码大小，节省时间并为您提供所需的灵活性。 哲学 减少您需要编写的与CRUD相关的代码。 它是代码，而不是黑匣子服务，您可以完全控制逻辑，部署等。 您无需学习新的随机定义：语法，指令，魔术等。 它与您现有的项目共存。 支持多个数据库：它应该支持支持的内容。 不建议您构建自己的复杂查询以支持复杂用例。 入门 以下内容可让您快速入门。 您可能要在参考完整的示例，其中包含测试数据。 安装套件 npm install graphql-server-crud 定义“模型” const { ModelBase } = require ( 'graphql-server-crud' ) const { knex } = require ( '../db' )
opencrud：OpenCRUD是用于数据库的GraphQL CRUD API规范
02-04
opencrud：OpenCRUD是用于数据库的GraphQL CRUD API规范
Twitter-Clone-GraphQL-后端：使用GraphQL的简单CRUD
02-05
GraphQL-Twitter克隆 要运行此graphql服务器，您需要： 克隆repo git clone 运行yarn或npm install 运行yarn watch或yarn build && yarn update-scehma && yarn start 然后转到： http://localhost:5000/graphql 可以进行的查询和变异： 查询 询问 描述 users 返回一堆用户 user 返回特定的用户 tweets 返回一堆推文 tweet 返回特定的tweet 变异 询问 描述 TweetAdd 添加新的推文 TweetEdit 在推文中编
GraphQL入门教程：构建更高效的APIs
最新发布
程序员二胖
04-02 591
在目录下创建.graphqls文件定义GraphQL模式。例如，): User): Booleanage: Intid: ID!age: Int。
深入了解 GraphQL API 设计：最佳实践
01-19 489
尽管这可能会增加开发的复杂性和成本，但能够避免用户升级时出现问题，这样能大大减少开发周期中返工的时间和代价。这就要求我们的 API 既要兼容以前的实现，也能适应未来的变革。如果不使用结构化的对象类型，参数列表可能会随着时间的推移而变得不必要地长，可能会导致代码的可维护性下降。参数结构需要保持稳定，以支持向后兼容性，同时也要灵活以便能够加入新的参数，以满足未来的需求。确保回传相关的响应信息，可以减少前端所需的请求次数，提高应用的性能效率。我们能够压缩返回的数据，从而减少传输数据量，加快响应速度。
如何使用GraphQL构建API？
m0_75198698的博客
05-07 255
此外，我们需要导入`books`数据，以便我们可以使用它来返回所有图书的列表。我们需要一个函数来处理addBook mutation，该函数将在books数组中添加新图书，并返回新添加的图书。假设我们需要添加一个新图书，我们需要在schema中定义一个mutation类型和一个addBook mutation。在项目的根目录下创建一个新的`models`目录，并在其中创建一个新的`user.js`文件。在这个Schema中，我们定义了一个`User`类型，该类型具有`id`和`name`属性。
vue中使用GraphQL查询api
csdn_chengpeng的博客
12-29 1949
vue+graphQL 前端使用graphQL 引入graphQL报错
探索GraphQL：下一代API技术
伤心的辣条
06-19 150
GraphQL是一种用于API的查询语言，它使得客户端能够准确地获取所需要的数据，而不是传统的RESTful服务那样，服务器定义了返回的数据。GraphQL让客户端有能力声明其数据需求，我们可以看一个简单的示例来理解这个概念：
添加用于管理用户对象的 CRUD Rest API
03-27
以下是一个可能的用户对象的 CRUD Rest API： 1. 获取所有用户 请求：GET /users 响应：200 OK ``` [ { "id": 1, "name": "Alice", "email": "alice@email.com" }, { "id": 2, "name": "Bob", "email": "bob@email.com" } ] ``` 2. 获取单个用户 请求：GET /users/{id} 响应：200 OK 或 404 Not Found ``` { "id": 1, "name": "Alice", "email": "alice@email.com" } ``` 3. 创建用户 请求：POST /users 请求体： ``` { "name": "Charlie", "email": "charlie@email.com", "password": "password123" } ``` 响应：201 Created ``` { "id": 3, "name": "Charlie", "email": "charlie@email.com" } ``` 4. 更新用户 请求：PUT /users/{id} 请求体： ``` { "name": "Alice", "email": "alice@example.com" } ``` 响应：200 OK 或 404 Not Found ``` { "id": 1, "name": "Alice", "email": "alice@example.com" } ``` 5. 删除用户 请求：DELETE /users/{id} 响应：204 No Content 或 404 Not Found

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值