飞布产品手册
官网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 提供支持
在本页
  • 核心界面
  • 概览页
  • 预览页
  • 设置页

这有帮助吗?

在GitHub上编辑
  1. 基础-可视化开发
  2. 概览

控制台

上一页CLI下一页主功能区

最后更新于1年前

这有帮助吗?

设置设置为了提供极致开发体验,飞布提供了友好的交互界面。本文重点介绍飞布的功能界面。

核心界面

上图是飞布的核心界面。它主要包含如下功能区:

  • 菜单栏:包含各种菜单和选项,以帮助您进行各种操作。

  • 功能面板:

  • 主功能区:根据功能面板的具体功能,展示对应的操作界面。

  • 日志面板:

    • 日志:展示编译后的所有日志,帮助定位问题

    • 问题:以结构化的方式展示具体问题,可直接定位问题点,如OPERATION不合法、数据库无法连接等

  • 状态栏:展示当前系统的运行状态

概览页

概览页包含:数据统计和通知。

  • 数据统计:统计功能面板各功能的数量,包含数据源、对外API、文件存储、身份验证

  • 通知:展示飞布发布的最新公告信息,点击更多可跳转至官方论坛

  • 指引:点击可以唤起新手引导功能。

预览页

预览页主要用来预览生成的API,它本质上是swagger文档的可视化展示。

  • API列表:以分组的形式展示API列表,主要包含operation编译的API和文件上传的API

  • API详情:选中API后,展示详情,包括operation、入参模型、响应模型

  • API测试:无需使用POSTMAN,输入入参,即可测试API

  • 授权登录:选择对应身份认证器,跳转登录后,可使用当前身份访问接口

  • swagger下载:可直接下载swagger文档,供第三方工具使用

设置页

设置页用来进行系统设置。

  • 外观:设置语言,当前支持中文和英文

  • 系统:

    • API域名:对外暴露API时的服务域名,控制台中有两个地方会用到:

      • API预览页

      • 复制API访问地址按钮

      • 0.0.0.0:所有IP都能访问,不安全,有两个常见用例

        • 不使用nginx代理,通过公网IP访问时

        • 在docker中启动时(在docker容器中,ip会被分到127.0.0.1)

    • 监听端口:核心引擎启动时监听的端口,用于暴露API,默认9991

    • 日志水平:核心引擎输出的日志水平

    • 调试:核心引擎是否开启调试

  • 安全:

    • 允许主机:允许访问核心引擎的主机地址,默认允许全部,否则需要配置白名单

  • 跨域:详情见 跨域访问

  • 环境变量:环境变量的增删改查,用于保证私密数据的安全,详情见

    • 可手动添加变量

    • 环境变量也可以在钩子服务中直接引用

  • 版本:展示系统版本和依赖库的版本信息

API设计:API设计相关的功能,包括、数据源、身份验证和文件存储

数据建模:数据库相关操作,简化版Navicat,包含和功能

详情前往

:核心引擎启动时监听的HOST

localhost:默认值,仅能本机访问,用后可外网访问

重定向URL:详情见

API管理
数据预览
数据建模
监听HOST
API预览
OIDC配置
主框架炸开图
概览页
API预览页
设置页
nginx代理