只用 GraphQL.OPERATION , Fireboom 能实现多少类型的 WEB API?

306 天前
 Fireboom

本仓库是 fireboom 的模板仓库,用于快速初始化 fireboom 项目。 飞布是下一代 API 开发平台,灵活开放、多语言兼容、简单易学,对标 Firebase ,但无供应商锁定。 它帮助你构建生产级 WEB API ,但无需花时间重复 coding 。 产品愿景:极致开发体验, 飞速布署 应用!

模板简介

init-todo 模板是 fireboom 的基础模板,只涉及OPERATION,不涉及钩子的编写。

Note 后续分别制作针对 go 和 nodejs 开发者的模板~

点击下述按钮,立即线上体验该模板:

https://gitpod.io/new/#https://github.com/fireboomio/init-todo

本模板的核心是在不引入钩子的情况下,尽可能用 OPERATION 表达各种 增删改查 请求。

使用模板

初始化项目 使用如下命令,一键安装 fireboom ,并以当前仓库作为模板初始化项目:

curl -fsSL fireboom.io/install | bash -s fb-project -t init-todo

其,核心格式为:

curl -fsSL fireboom.io/install | bash -s fb-project -t [template_name]

其中 [template_name] 为对应模板的仓库名称,例如本仓库的 init-todo 。

运行 fireboom 直接执行下面的命令行,以开发模式启动:

# 启动成功日志:
Web server started on http://localhost:9123

打开控制面板 http://localhost:9123

更新 fireboom 此外,如果要更新 fireboom 版本,使用如下命令行:

curl -fsSL https://www.fireboom.io/update | bash

如果要使用预览版本,用如下命令行:

curl -fsSL https://www.fireboom.io/update-test | bash

模板详情

数据源

sqlite 数据源 为了降低启动成本,本模板引入了最少的外部依赖,因此用 sqlite 数据库作为演示。

Note 但额外的代价是,sqlite 不支持一些高级特性,例如数组类型。

todo 数据库 一个待做事项数据库,只包含 Todo 表,其 schema 如下:

datasource db {
  provider = "sqlite"
  # url 中的绝对路径,因系统不同而不同
  url      = "file:/workspaces/init-todo/upload/sqlite/todo.db"
}

model Todo {
  id        Int      @id @default(autoincrement())
  title     String
  completed Boolean  @default(false)
  createdAt DateTime @default(now())
  authorId  Int?
}

blog 数据库 一个简化版博客系统数据库,其 schema 如下:

datasource db {
  provider = "sqlite"
  # url 中的绝对路径,因系统不同而不同
  url      = "file:/workspaces/init-todo/upload/sqlite/blog.db"
}

/// 文章分类
model Category {
  id   Int    @id @default(autoincrement())
  name String @unique
  Post Post[]
}

/// 文章表
model Post {
  id        Int        @id @default(autoincrement())
  title     String
  published Boolean
  view      Int?
  like      Int?
  authorId  Int
  content   String?
  User      User       @relation(fields: [authorId], references: [id])
  Category  Category[]
}

/// 用户详细信息
model Profile {
  id      Int    @id @default(autoincrement())
  address String
  userId  Int    @unique
  User    User   @relation(fields: [userId], references: [id])
}

/// 用户表
model User {
  id      Int      @id @default(autoincrement())
  email   String   @unique
  age     Int?
  country String?
  Post    Post[]
  Profile Profile?
}

REST api 数据源

系统内置数据源,system REST 在 fireboom 启动时默认生成,包含了 fireboom 的所有 REST 接口。 其 swagger 定义,详情见文件:upload/oas/system.json

数据库接口

fireboom 的数据库操作,基于 prisma实现,因此支持 prisma 引擎的所有特性。 参考 prisma 官方文档,梳理了 5 个目录的 operation 。

Note 上述示例,未提及 OPERATION 编译为 REST API 后,如何传递入参。标量入参比较简单,无需额外介绍。若入参为对象或数组时,则需要掌握对应技巧,详情参见 文档

高级特性

n06advanced 目录 包含了很多高级特性,可分为:

Note 指令修饰的 OPERATION ,只有编译为 API 后才生效,因此无法在 OPERATION 编辑页测试,请在 API 预览页验证其最终效果。(跨域关联除外)

跨域关联 示例位于目录:store/operation/n06advanced/join 默认情况下,OPRATION 都是 并行 执行,但很多场景需要先查询数据,然后将返回值作为条件,执行下一个查询/变更。 因此,通过 字段: _join 、 _join_mutation 和指令: @internal 、 @export 实现了该特性。

事务控制 示例位于目录:store/operation/n06advanced/transaction 默认情况下,MUTATION OPRATION 都是 并行 执行,但很多场景需要保证原子性。

Note 除了用 @transaction 指令,还可以在钩子中执行事务,待完善文档。

参数注入 示例位于目录:store/operation/n06advanced/variable_pro 默认情况下,OPERATION 参数只能从请求 url path 或 body 中读取,有些场景需要在服务端设置。

入参校验 示例位于目录:store/operation/n06advanced/variable_pro/jsonschema 为保证安全性,OPERATION 参数需要校验,指令 @jsonSchema 用来实现该功能。

响应控制 示例位于目录:store/operation/n06advanced/selection_pro 默认情况下,OPERATION 编译的 REST API ,其响应值为对应数据源中的字段命名。某些场景下,要根据前端需求返回对应的别名或结构。

设置相关 示例位于目录:store/operation/n06advanced/setting 除了 OPERATION 描述 API 外,还可以额外设置特性。

OIDC 相关

fireboom 还支持身份认证,基于OIDC 协议实现了灵活的身份验证机制。

设置接口授权 示例位于文件:store/operation/n07oidc/auth

API 设置步骤

  1. 选中接口,查看右侧面板,切换到 “设置”
  2. 开启“使用独立配置”,并开启“接口授权”
  3. 再次访问该接口需要登录

用户参数注入 示例位于目录:store/operation/n07oidc/fromclaim

Note OIDC 规范中只声明里用户相关的数据,如 UID 、EMAIL 。若想注入业务数据,可编写钩子,详情见 文档代码片段

测试登录 系统内置了 身份验证 供应商 auth0 ( https://auth0.com/) 如果用 localhost:9123 访问控制台

  1. 打开 api 预览页:[http:// localhost:9123 /#/workbench/rapi]( http:// localhost:9123 /#/workbench/rapi)
  2. 在右上角 <未登录> 中点击 进行登录
  3. 输入账户/密码: test@example.com /1QAZ2wsx
  4. 登录后可查看当前登录用户的信息
  5. 最后,在预览页测试 @fromclaim 修饰的 OPERATION

如果用 自定义域名,如 http://test.fireboom.io:9123 访问控制台,需要额外配置

  1. 前往 auth0 后台,设置 -> 为 身份验证 供应商的「登录回调地址」
  2. 前往 firebom 控制台 [设置]->[安全]-><重定向 URL>,新增 url: [http://test.fireboom.io:9123 /#/workbench/rapi/loginBack]( http://test.fireboom.io:9123 /#/workbench/rapi/loginBack) 详情参考 文档

钩子相关

至此,该模板的核心功能已经介绍完毕。后面内容可跳过。 该模板的目标是尽可能多的描述只用 OPERATION 就能完成的场景,但仍有些场景需要编写代码才能实现。这就需要用到 fireboom 的钩子机制。

Note 目前已支持 NodeJS 、Golang 、Java 的 SDK ,其他未提供 SDK 的语言,可基于HTTP 规范 自行开发。

钩子使用,详情参考 文档

内部调用 @internalOperation 示例位于文件:store/operation/n10hook/internal 默认情况下,OPERATION 将被编译为 REST API ,某些场景下我们希望某 OPERATION 仅用于内部(类似内部函数,不对外导出)。 指令 @internalOperation 用于实现该功能,其修饰的 OPERATION 不会编译为 REST API ,只能在钩子中调用,详情见 文档

接口权限控制 @rbac 示例位于文件:store/operation/n10hook/rbac 对于中后台应用,不仅要控制接口的数据权限,还要控制接口只能被拥有某些角色的用户(管理员)访问。

角色注入 在身份验证钩子 mutatingPostAuth 中,可为用户注入角色,详情参考 文档 为用户注入角色后,firebom 会判断用户的角色与 @rbac 指令 要求的角色是否匹配,确定是否可以访问该接口。

动态权限 @rbac 指令不够灵活,只适用于静态场景,在中后台应用中一般用钩子实现。 在 全局钩子 beforeRequest 中,可为接口动态设置需要的角色,详情参考 示例代码

参考

728 次点击
所在节点    分享创造
0 条回复

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/1010588

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX