GraphQL 接口设计

graphql 是一种用于 API 的查询语言。它提供了一套完整的和易于理解的 API 接口数据描述,给客户端权力去精准查询他们需要的数据,而不用再去实现其他更多的代码,使 API 接口开发变得更简单高效。 最近在用Gatsby开发一版静态博客,感觉和这个框架真是相见恨晚。因为这个框架使用到了 graphql 技术,所以我花了点时间去学习了一下,并且记录了一下学习和思考过程。 本文主要讲解如何理解 graphql 以及基于关系型数据库设计 graphql 的思路。如果需要学习 graphql 基础知识,请移步官方文档 本文包含Nestjs + graphql 的示例项目:https://github.com/YES-Lee/nestjs-graphql-starter 理解 graphql graphql 是一个用于描述数据及其关系的查询语言,官方文档中描述了 graphql 的标准,具体的实现依靠第三方,目前主流的是Apollo提供的解决方案。 graphql 并不关心具体我们是怎么获取数据的,我们只需要提供获取数据的方法(resolver)以及如何组装数据(schema)。类似于 Java 开发过程中的接口设计模式,Graphql 定义了一套标准,我们按照标准实现接口。下面以用户-角色模型举例。 下面的代码定义了两个数据结构,与 JSON 类似,应该很容易理解。它描述了每个类型(type)的名称,以及其包含的属性。属性除了可以是基本类型外,也可以是数组、其他引用类型,从而建立起所有数据模型及相互的关系图。 type Role { name: String note: String } type User { id: Int name: String gender: Int role: Role } 上面代码用于描述Role和User的数据结构,那么我们具体要怎么使用这个东西呢?先从前端的角度来看,可以从官方文档学习到前端的基本使用,请求体中的数据描述和上面定义类型的代码有些许差别,比如我们要查询用户数据: query userInfo { user(id: Int) { id name gender role { name note } } } 从上面的代码可以大概猜测出,如果我们不需要查询role数据是,只需要将其从请求中去掉...

March 25, 2020 · 3 min · 464 words · Johnson

sequelize-typescript-auto

从mysql数据库自动生成sequelize-typescript风格的models,最初用于nestjs项目,同时也适用与其它使用sequelize-typescript的项目。 项目地址:https://github.com/YES-Lee/sequelize-typescript-auto 使用 // 安装 npm install -g sequelize-typescript-auto // 使用 sequelize-typescript-auto -H localhost -d test -u root -x 123456 -p 3306 -f test_ -o ./_models 选项 使用: sequelize-typescript-auto [选项] 选项: -V, --version 版本 -H, --host <host> 数据库地址 -d, --database <database> 数据库名称 -u, --username <username> 用户名 -x, --password <password> 密码 -p, --port <port> 数据库端口,默认为3306 -o, --output <dir> model输出文件夹 -f, --prefix <prefix> 在文件名和model类名中过滤数据库前缀 -h, --help 显示帮助信息 Features 支持 mysql 命令行使用 编程方式使用 生成外间约束关系 检查文件哈希值 生成计数器 支持 SQL Server 支持 PostgreSQL

February 15, 2020 · 1 min · 78 words · Johnson

nestjs快速开发项目

整合了nestjs项目通用架构、常用功能集成的一个快速开发项目。 项目地址:https://github.com/YES-Lee/nest-seed-proj 集成功能 ORM: sequelize API: restful api, graphql 认证:passport 文档:swagger 安全:helmet 日志:nest-pino 功能不断完善,将来或提供可插拔的开发体验 快速开始 # 拉取代码 git clone https://github.com/YES-Lee/nest-seed-proj.git cd nest-seed-proj yarn install # or npm intall yarn start:dev # or npm run start:dev 项目结构 src ├─ config // 配置模块 ├─ database // 数据库模块 │ └─ models // 存放sequelize/graphql数据库模型 ├─ decorators // 自定义装饰器目录 ├─ dto // restful 接口模型目录 ├─ graphql // graphql 模块 ├─ enums // 枚举目录 ├─ filters // error filters ├─ interceptors // interceptors ├─ pipes // pipes └─ modules // 业务逻辑模块目录,所有业务相关逻辑都放到该目录对应的模块 接口格式 { error_code: number // 错误码,只在异常时返回 error_message: string // 错误信息,只在异常时返回 data: any timestamp: any // 时间戳 path: string // 请求路径 } dtc/support中提供了ApiResponse类,提供了success, error两个静态方法。...

February 15, 2020 · 2 min · 284 words · Johnson