飞布产品手册
官网B站Github
V2.0
V2.0
  • 序言
  • 更新日志
    • 更新日志V2.0
    • V2.0更新说明
    • 更新日志V1.0
  • 产品简介
    • 什么是飞布?
    • 飞布的价值
    • 飞布的优势
    • 应用场景
    • 数据安全
    • 产品案例
  • 快速入门
    • 初识飞布
    • 快速上手
      • 图文版
    • 词汇概览
    • 工作原理
  • 基础-可视化开发
    • 概览
      • CLI
      • 控制台
        • 主功能区
    • 数据源
      • 数据库
        • 数据库连接
          • 高级设置
        • 数据建模
        • 数据预览
      • Prisma 数据源
      • REST 数据源
      • GraphQL 数据源
      • 消息队列
    • API构建
      • 可视化构建
        • API规范
      • 批量新建
      • HTTP请求流程指令
      • 使用API
      • 实时查询
      • 实时推送
      • 关联查询
      • 数据缓存
      • 常见用例
    • 身份验证
      • 授权码模式
        • 身份验证(废弃)
      • 隐式模式
      • 数据权限控制
    • 身份授权
      • RBAC
        • 授权与访问控制(废弃)
      • 接口权限控制
      • 开放API
    • 文件存储
      • S3配置及使用
      • 文件管理面板
      • 高级配置:profile
  • 进阶-钩子机制
    • 钩子概览
    • 启动钩子
      • Node钩子
      • Golang钩子
      • Java钩子
      • Python钩子
    • OPERATION钩子
    • 身份验证钩子
    • graphql钩子
    • 函数钩子
      • function
      • proxy
    • 文件上传钩子
    • 内部调用
  • 使用-部署上线
    • 部署运维
      • 手动部署
        • 流水线部署(废弃)
      • Docker部署
      • 飞布云
      • sealos部署
    • 接口安全
      • CSRF token 保护
      • 跨域访问
    • 客户端SDK
      • Js SDK
      • 微信小程序SDK
      • Flutter SDK
      • uniapp SDK
    • 性能测试
  • 迁移到V2
  • 环境准备
    • 文件存储 S3
    • 身份认证 OIDC
    • NodeJs环境
  • 实战案例
    • Amis Admin
      • 管理后台-refine(废弃)
    • 实时TODO LIST
    • 语音版ChatGPT
    • AI魔法师实战
    • 阿里低代码引擎
    • appsmith集成
  • Roadmap
  • 常见问题
  • 核心概念
    • GraphQL
    • 超图
    • 请求时序图
    • 服务端Operation
  • 二次开发
    • 钩子规范
      • 钩子规范bak
    • 模板规范
    • 自定义模板
    • 其它参考
由 GitBook 提供支持
在本页
  • 前置知识
  • 公共知识
  • 快速使用
  • 环境准备
  • 在线体验
  • Docker运行
  • 本地安装
  • 运行飞布
  • 高级特性
  • 下一步
  • 学习教程
  • 数据库操作
  • 业务逻辑

这有帮助吗?

在GitHub上编辑
  1. 快速入门

快速上手

上一页初识飞布下一页图文版

最后更新于1年前

这有帮助吗?

本文主要介绍从初识飞布到快速了解飞布功能从而搭建第一个API并有效访问的完整流程。

前置知识

公共知识

  • GraphQL:了解什么是GraphQL,掌握基本概念就行,推荐教程

  • Prisma ORM:了解Prisma的基本函数签名,推荐教程

快速使用

简单使用,只需要观看本视频即可,后面内容可忽略。

环境准备

在线体验

启动成功后,在 gitpod 底部切换到PORTS面板,选择 9123 端口打开即可

Docker运行

# 开发模式运行
docker run -it -p 9123:9123 -p 9991:9991 fireboomapi/fireboom_server:latest dev 

打开控制面板,使用如下地址进行访问:

本地安装

脚本安装

如果你使用的是Windows系统,建议使用 Git bash 执行脚本,或者在MSYS2等环境下执行脚本,不支持在CMD或者PowerShell终端中执行

curl -fsSL fireboom.io/install | bash -s project-name -t init-todo --cn
  • 项目名称:project-name,可根据需求修改

  • 初始化模板:-t init-todo,省略后默认创建空项目

  • 选择源:--cn ,指定从国内源下载,省略后从 github源下载

模板列表:

  • init-hooks:钩子模板,提供 golang 和 nodejs 的示例 (inprocess)

升级飞布

# 升级飞布命令行
# cd project-name
curl -fsSL fireboom.io/update | bash

运行飞布

# 开发环境
# cd project-name
./fireboom dev

启动成功日志:

⇨ http server started on [::]:9123

打开控制面板

高级特性

如果你要使用钩子等高级特性,则需要掌握一种后端开发语言。

如果你是前端开发者,推荐:

如果你是后端开发者,推荐:

下一步

学习教程

数据库操作

业务逻辑

实现自定义业务逻辑有几种不同的选项,具体取决于你的用例。

:Gitpod是一个在线IDE,可以从任何GitHub页面启动。在几秒钟之内,Gitpod就可以为您提供一个完整的开发环境,包括一个VS Code驱动的IDE和一个可以由项目定制化配置的云Linux容器。

飞布采用golang语言编写,上述版本基于golang的跨平台编译构建。如果你的操作系统不在上述列表,请兼容。

: 基础模板,只涉及 ,不涉及钩子编写

TypeScript:了解node.js并熟悉TypeScript语法,推荐教程

Golang:了解Golang基本语法即可,推荐教程

体验fireboom更多特性,可前往B站查看完整教学视频,。

:学习如何使用飞布建模数据库,参考

:了解数据库表结构和graphql的映射关系,参考 。

:在请求API的生命周期中,插入代码,以更改或扩展API行为,例如用户新建文章后,通过后置钩子发送邮件通知管理员审核。

API数据源:除数据库外,飞布支持集成和,开发者可以自行用喜欢的方式实现自定义逻辑的API,但无需考虑权限问题。飞布此时变身API网关,作为BFF层对外提供接口。

:飞布还内置了自定义数据源,开发者可以直接编写脚本扩展逻辑。它本质上也是一个GraphQL API。

:适用于复杂业务逻辑的构建,当前只支持TS hooks。

gitpod 介绍
http://localhost:9123
联系我们
init-todo
OPERATION
http://localhost:9123
前往
前往
前往
数据库建模
prisma文档
API钩子
REST API
GraphQL API
自定义数据源
组合式API
前往
前往
prisma文档
Open in Gitpod
01入门教程-如何快速上手飞布?
00功能介绍-如何安装或升级飞布?
数据库CRUD