淘宝旺铺模板制作sdk引擎介绍以及模板编写规范.docVIP

一 SDK使用入门 什么是SDK SDK是淘宝提供给设计师在本地设计模板的软件开发包。SDK在设计师本地电脑提供一份模拟数据，设计师通过模拟数据在本地渲染模板。 总体介绍 2.1 SDK的安装 首先从如下地址“http:”下载SDK安装包，然后将安装包解压到任何一个本地磁盘目录：解压后的目录结构如下图所示： 下面详细介绍各个目录的作用： bin目录： bin目录主要放置启动和关闭SDK的脚本命令 conf 目录： conf 目录主要存放SDK的配置文件以及SDK web控制台的war应用 db目录： db目录主要存放SDK本体模拟数据文件，设计师设计的模板在本地渲染的时候，数据就是从此目录的文件中读取的。 htdocs目录： htdocs目录存放设计师设计的模板文件，这个目录下可以存放多套模板文件 lib 目录 lib目录主要存放SDK运行所需要的jar包 logs目录 logs目录主要存放SDK运行的日志文件 template 目录 template目录主要存放模板zip包，当设计师在SDK web控制台打包模板以后，SDK会生成一个zip文件到当前的目录。 2.2 SDK的启动 在SDK本地安装路径找到bin目录，点击StartServer.bat启动SDK，启动后输入HYPERLINK http://localhost:8080/_ahhttp://localhost:8080/_ah进入SDK web控制台首页。 2.3 Quick Start 第一步：请到HYPERLINK ,, 下载DemoTemplate.zip。 第二步：将下载后的DemoTemplate.zip解压到SDK本地安装目录的htdocs目录下，如图所示： 第三步：请到SDK本地安装目录的bin目录，点击StartServer.bat启动SDK，启动后输入HYPERLINK http://localhost:8080/_ahhttp://localhost:8080/_ah进入SDK web控制台首页。 第四步：点击我的模板标签，系统显示模板列表 第五步：点击模板列表页的按钮进行模板预览 3 Web 控制台 SDK web 控制台提供了创建本地模板以及模板打包,发布等的功能，设计师通过SDK web控制台可以预览本地模板以及打包和发布模板。 3.1创建模板 首先进入Web控制台首页，然后点击按钮，进入模板创建界面如下图所示： 在目录名称中输入本地存放模板的目录，此目录默认会放在SDK安装目录的htdocs目录下面，然后依次输入模板名称，作者姓名，旺旺名称，版本号以及模板采用的语言等信息，点击下一步进行模板的创建。如果模板创建成功会在本地SDK安装目录下htdocs目录中生成对应的模板文件，默认情况下会生成全局的css文件，页头，页尾，详情页，文章页，以及促销页面以及模板的描述文件，具体的目录结构如下图所示： 3.2模板预览 首先进入SDK web控制台首页，然后点击我的模板，系统显示所有本地模板列表，如下图所示： 点击上图中的按钮，SDK显示具体本地预览效果。 3.3模板打包 首先点击模板缩略图或者模板名称进入模板详情页面，点击按钮，系统会将本地htdocs目录下面对应的模板目录进行打包，同时将打包后的zip文件放到SDK本地安装目录的template目下，具体如下图所示： 3.4模板发布 首先点击模板缩略图或者模板名称进入模板详情页面，点击按钮，系统首先会对当前的模板进行打包，打包后会在htdocs目录对应的模板目录下生成一个zip文件，然后系统会将跳转到淘宝接受zip包的入口进行zip包的上传。 二 开放接口详解 2.1 ShopManager 2.1.1 店铺数据描述 店铺标识：id 店铺标题：title 店铺主营：mainBusiness 开店时间：startTime 店主标识: ownerId 店主昵称：ownerNick 店标url : logoUrl 店铺域名：domainName 收藏人气：collectCount 2.1.2 接口说明 ShopManager主要负责获取店铺信息，ShopManager提供了两个接口： 获取店铺介绍: findIntroduction 获取店铺公告：findBulettin 2.1.3 接口用法 PHP模板用法： 获取店铺介绍： ?php $shopIntroduction = $shopManager-findIntroduction() echo shopIntroduction ? 获取店铺公告： ?php $shopBulettin = $shopManager-findBulettin() echo shopBulett