目录结构

├── css/                        # 样式文件
│   └── ...
├── feature/
├── html/
│   └── ...
├── icon/                       # 图标文件目录
│   └── ...
├── image/
│   └── ...
├── launch/                    # 启动图片目录
│   └── ...
├── res/
│   └── ...
├── script/
│   └── api.js                 # 最基础的 JavaScript 方法,所有方法在 window.$api 对象下
├── wgt/
│   └── ...
├── config.xml                 # 配置文件,必须
├── index.html                 # 启动页面,必须

config.xml

<widget id="A12345678901"  version="0.0.1">
    <name>API Example</name>
    <description>
        API Example App.
    </description>
    <author email="[email protected]" 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调用

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

代码参考:http://docs.apicloud.com/APICloud/junior-develop-guide#j4

results matching ""

    No results matching ""