陈斌彬的技术博客

Stay foolish,stay hungry

创建APICloud应用

一、准备工作

下载并安装 APICloud IDE 开发环境,IDE 当前支持 Windows 系统。

二、创建应用

APICloud 提供了两种应用创建方式,方便开发者在云端和 IDE 中创建应用。

云端创建应用:

1) 注册并登录 APICloud 系统:http://www.apicloud.com/console 点击左上角“创建应用”, 如图:选择“Native”,填写“名称”及“说明”,应用创建完成。

img

应用概览页 http://www.apicloud.com/appoverview 可以看到应用相关信息,留意一下应用 ID,IDE 会用到。

img

2) 用以上注册的 APICloud 账号登录 IDE

img

3) 登录后,左侧选择“云端资源库”,根据 APICloud 创建的应用 ID 选择 SVN 项目

img

4) 选择项目,右键“检出为”,点击“完成”,应用创建完成。

img

IDE中创建应用:

1) 顶部菜单选择 “文件” → “新建” → “创建 APICloud 项目”。

2) 填写“应用名称”,“应用说明”,点击完成,即完成创建。

img

三、应用包结构

img

“config.xml”和 “index.html” 必须包含,其它均为可选。“config.xml”是配置文件,“index.html”是启动页面,“icon”为图标文件目录,“launch”为启动图片目录(更多介绍详见Widget包结构说明文档)。

四、Config.xml 配置文件

 <widget id="A12345678901"  version="0.0.1">
    <name>API Example</name>
    <description>
        API Example App.
    </description>
    <author email="developer@apicloud.com" href="http://www.apicloud.com">
        APICloud.SIR
    </author>
    <content src="index.html" />
    <access origin="*" />
    <preference name="windowBackground" value="#FFF" />
    <permission name="call" />
    <feature name="weiXin">
        <param name="urlScheme" value="wx7779c7c063a9d4d9" />
    </feature>
</widget>
  • “id”: 必填,应用ID,由云服务器自动分配。它是该应用的唯一标识。
  • “version”:必填,应用的版本号。
  • “name”:必填,应用名称。
  • “description”:可选,应用简单描述信息。
  • “content”:必填,应用运行的起始页。
  • “permission”:必填,权限配置。 (详细介绍见应用配置指南文档)

五、前端开发框架

我们提供了核心的 api.css 和 api.js 前端框架,可与第三方前端框架混用,也可不用我们的框架;api.css 处理不同平台浏览器的默认样式,api.js 提供最基础的 JavaScript 方法,所有方法在 window.$api 对象下。

(详细文档见Framework开发指南文档)

六、端API调用

  1. 核心模块在 window.api 对象下,默认提供该模块,不需要单独引用。
  2. 扩展模块在相应的模块对象下(例如:文件系统模块在 fs 对象下),需要 require 引入(var fs = api.require(‘fs’))。API核心模块已经覆盖一般应用的绝大部分功能。
  3. 模块中所有方法均遵循 api.functionName(params, callback)格式,params 为 JSON 格式,callback 是 Function 类型,callback 返回两个参数,均为 JSON 格式:callback(ret, err),ret 处理成功信息,err 处理错误信息。
  4. apiready 方法在所有核心 API 模块准备完毕时执行。 (详细介绍见 api 文档)

七、真机同步调试

打开 IDE,用数据线连接移动设备,当前项目下,右键选择“一键真机同步测试”

img

等待同步完成,项目代码被拷贝到移动设备指定目录,移动设备上的 APP Loader 自动启动,即可实现真机同步调试。

点击顶部的“启动日志”按钮,当真机调试的应用有 JavaScript 错误时,IDE 的控制台会有日志输出。

八、本地打包

选择应用项目,右键选择“生成快速测试包”,填写“应用名称”,选择“生成平台”,点击“打包”,即可生成测试安装包。(更多详尽功能参见IDE使用指南)

九、云端编译

登录 APICloud 系统

img

img

img

img

  • 云编译 http://www.apicloud.com/package 选择“云编译”菜单,选择相应平台(Android 或 iOS),选择编译类型(测试版或正式版),点击“云编译”按钮,耐心等待编译完成

img

  • 下载安装 扫描二维码可以下载安装应用至移动设备