基本介绍

更新时间:2023-03-08 20:00

环境要求

由于 WitFrame 的线上应用运行在 PHP 8.1 下,因此目前此 SDK 的运行要求也同样为 PHP 8.1,进行应用的开发前请自行准备好此开发环境。

首页

SDK 首页目录为 /www 目录,对应 URL 类似于 “ http://youwebsite/WitSdk-Dev/www ”,您可以通过 web 服务器指向此目录。

系统配置

在正式进行 WitFrame 应用开发前,请先在 WitFrame 平台注册账号,并在开放平台激活成为开发者。
然后进入我的项目,选择“开发者测试项目”,进入“通讯设置”,复制“配置导出”中的代码,粘贴到“配置导入”中,完成配置。

数据库配置和Redis配置可以依照您的开发环境自行配置。

保存后的设置会保存在 /conf/config.ini 文件中。

创建应用

在此处直接创建一个应用,此操作会在本地创建目录结构的同时在 WitFrame 创建相同的应用和分支,创建后可自行去应用管理中设置详细资料

应用的目录结构为 /www/[app]/[ver]

  • [app] 为应用ID
  • [ver] 为版本ID

版本的作用,您可以把应用的不同差异化内容按照不同版本目录去划分,也可以把您应用的数据内容、静态内容做为不同版本目录去划分,具体由您而决定

应用ID和分支ID的创建应符合以下要求:

  • 应用ID只能包含英文字母;分支ID由英文字母及数字组成,大小写不限制;
  • 如果应用ID包含前缀,只能填写当前开发者身份的应用前缀;
  • 应用前缀请用下划线(“_”)与后续字符分隔,如“Wit_hello”,但只能有一个下划线;
  • 应用ID首字母大写,后面一律小写;

WitFrame 目前只负责自动创建一个分支,创建第二个分支,请自行在本地创建子目录,当应用提审的时候,在平台人工创建。

分支类型

  • 在线运行
    在线运行类的分支为在 WitFrame 云端服务器上运行的脚本,用户购买安装后看不到代码,直接使用临时域名或者转移自己的域名到 WitFrame 中即可运行。

  • 资料下载
    资料下载类的分支会提供给用户一个 zip 包下载后阅读或使用。可以为代码、素材或者说明文档。

    • 小程序包:
      如果资料下载类的分支中包含如下 conf/wechatMini.yaml 文件,此分支会自动识别为小程序包。wechatMini.yaml 的配置说明参见文档“小程序包”。

应用提审

应用开发完毕后,通过此操作可以直接把应用打包发送到 WitFrame,之后您可以在应用管理中找到待提审的分支,发送提审单。

Git 提审

如果您有自己的 Git 仓库,可以直接通过 Git 进行应用的提审操作。请先到相关应用的基本资料中设置 Git 参数。
Git 的目录结构以“应用ID”目录为根目录,“分支ID”目录为子目录。
设置了 Git 提审后,当您的 Git 仓库有更新后,直接在应用管理处点击“Git提审”即可。

在 WitFrame 设置您 Git 仓库地址的时候,对于以下仓库,如不方便提供账号,可添加 WitFrameAuditor 为观察者成员:

  • gitee.com
  • github.com

安装

如果 /www/[app]/[ver]/install 目录下存在 install.sql 及 data.sql 文件,此操作会执行相应的 SQL 语句。

详情请阅读“安装”章节

应用设置

如果 /www/[app]/[ver]/conf 目录下存在 /conf/setting.yaml 文件,会跳转到线上的应用配置页面,此页面是根据此 yaml 文件生成的。
如果您是本地、局域网内开发 WitFrame 读取不到此文件的内容,您可以自行粘贴此文件的内容在应用配置页面,对于您未来的最终客户是不存在此情况的。

详情请阅读“应用配置”章节