移动端接口设计（移动端接口设计规范）

本篇文章给大家谈谈移动端接口设计，以及移动端接口设计规范对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。 今天给各位分享移动端接口设计的知识，其中也会对移动端接口设计规范进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、如何设计一个优秀的移动端接口服务器
• 2、type-a和type-c区别
• 3、RESTful api接口安全优雅设计
• 4、如何利用Thinkphp框架开发移动端接口详解

如何设计一个优秀的移动端接口服务器

下面简单介绍一种或许可行的方案，仅供参考
------------------------
1）默认要有一个版本更新接口
告诉客户端当前版本是否还在兼容范围内，假如不是，强制升级。（假如还可以用且不是最新，建议升级）
2）接口多版本并存规则
同一个业务接口，可能存在多个版本。
如 购物下单，可能由于业务需求的变更，导致存在着 1.0 / 2.0 / …… 等多个接口
[version] //默认版本
public void Order()
[version(1.2)] //1.2版本
public void Order()
[version(2.0-3.4)] // 2.0-3.4版本
public void Order()
多版本管理，特殊版本则调用特殊方法，不存在特殊版本/不在特殊版本内，则调用通用方法。
假如是未来那个版本做大变更了（将成为通用版本），那么无外乎就是把主/特殊 对调一下
[version] //默认版本
public void Order()
[version(1.0-1.1)] //1.0-1.1版本
public void Order()
[version(1.2)] //1.2版本
public void Order()
3）给客户端分配版本号并管理好
调用方式可以类似所有请求加版本号，从原来的 http://url/…… 变更为 http://url/v1.0/…… 表示当期客户端用的是 1.0版本接口
4）其他说明
这个方案需要关注的是，客户端对接口版本调用的对应关系的管理。

type-a和type-c区别

Type-C与Type-A两种接口最大的区别在于使用范围的不同。

Type-A主要用于电脑PC端以及充电器等设备移动端接口设计，是目前应用范围最广的USB接口标准移动端接口设计，普及率高，但这种接口类型也有其弊端，需要区分正反面，并且接口体积比较大。

Type-C是最新型的移动端USB接口类型。Type-C接口是USB 3.1的标准，这种接口的优势在于设计小巧，插座端尺寸仅为8.3mm乘2.5mm，传输速度快，最高传输速度可达10Gbps，此外还具备最高100W的强力电力输出能力。

【拓展】

USB，是英文Universal Serial Bus（通用串行总线）的缩写，是一个外部总线标准，用于规范电脑与外部设备的连接和通讯，是应用在PC领域的接口技术。

RESTful api接口安全优雅设计

-- 陈万洲

在项目中，需要为APP撰写API。刚开始接触的时候，并没有考虑太多，就想提供URL，APP端通过该URL进行查询、创建、更新等操作即可。但再对相关规范进行了解后，才发现，API的设计并没有那么简单，远远不是URL的问题，而是一个通信协议的整体架构

请求模式也可以说是动作、数据传输方式，通常我们在web中的form有GET、POST两种，而在HTTP中，存在下发这几种。

常见的请求参数

比如在数据过多, 需要对数据进行分页请求的时候, 我们应该统一 API 请求参数. 常见的有这些.

API的开发直接关系了APP是否可以正常使用，如果原本运行正常的API，突然改动，那么之前使用这个API的APP可能无法正常运行。APP是不可能强迫用户主动升级的，因此，通过API版本来解决这个问题。也就是说，API的多个版本是同时运行的，而且都要保证可以正常使用。

按照RESTful的规范，不同的版本也应该用相同的API URL，通过header信息来判断版本，再调用不同版本的程序进行处理。但是这明显会给开发带来巨大的成本。

解决办法有以下几种：

接口的数据一般都采用JSON格式进行传输，不过，需要注意的是，JSON的值只有六种数据类型：

所以，传输的数据类型不能超过这六种数据类型。以前，我们曾经试过传输Date类型，它会转为类似于"2016年1月7日 09时17分42秒 GMT+08:00"这样的字符串，这在转换时会产生问题，不同的解析库解析方式可能不同，有的可能会转乱，有的可能直接异常了。要避免出错，必须做特殊处理，自己手动去做解析。为了根除这种问题，最好的解决方案是用毫秒数或者字符串表示日期。

服务器返回的数据结构，一般为：

不同错误需要定义不同的返回码，属于客户端的错误和服务端的错误也要区分，比如1XX表示客户端的错误，2XX表示服务端的错误。这里举几个例子：

错误信息一般有两种用途：一是客户端开发人员调试时看具体是什么错误；二是作为App错误提示直接展示给用户看。主要还是作为App错误提示，直接展示给用户看的。所以，大部分都是简短的提示信息。

data字段只在请求成功时才会有数据返回的。数据类型限定为对象或数组，当请求需要的数据为单个对象时则传回对象，当请求需要的数据是列表时，则为某个对象的数组。这里需要注意的就是，不要将data传入字符串或数字，即使请求需要的数据只有一个，比如token，那返回的data应该为：

首先，使用https可以在数据包被抓取时多一层加密。我们现在的APP使用环境大部分都是在路由器WIFI环境下，一旦路由器被入侵，那么黑客可以非常容易的抓取到用户通过路由器传输的数据，如果使用http未经加密，那么黑客可以很轻松的获取用户的信息，甚至是账户信息。

其次，即使使用https，也要在API数据传输设计时，正确的采用加密。例如直接将token信息放在URL中的做法，即使你使用了https，黑客抓不到你具体传输的数据，但是可以抓到你请求的URL啊！（查了资料了，https用GET方式请求，也仅能抓到域名字符部分，不能抓到请求的数据，但是URL可以在浏览器或特殊客户端工具中直接看到。多谢下面的朋友指正错误）因此，使用https进行请求时，要采用POST、PUT或者HEAD的方式传输必要的数据。

现在，大部分App的接口都采用RESTful架构，RESTFul最重要的一个设计原则就是，客户端与服务器的交互在请求之间是无状态的，也就是说，当涉及到用户状态时，每次请求都要带上身份验证信息。实现上，大部分都采用token的认证方式，一般流程是：

然而，此种验证方式存在一个安全性问题：当登录接口被劫持时，黑客就获取到了用户密码和token，后续则可以对该用户做任何事情了。用户只有修改密码才能夺回控制权。

如何优化呢？第一种解决方案是采用HTTPS。HTTPS在HTTP的基础上添加了SSL安全协议，自动对数据进行了压缩加密，在一定程序可以防止监听、防止劫持、防止重发，安全性可以提高很多。不过，SSL也不是绝对安全的，也存在被劫持的可能。另外，服务器对HTTPS的配置相对有点复杂，还需要到CA申请证书，而且一般还是收费的。而且，HTTPS效率也比较低。一般，只有安全要求比较高的系统才会采用HTTPS，比如银行。而大部分对安全要求没那么高的App还是采用HTTP的方式。

我们也给每个端分配一个appKey，比如Android、iOS、微信三端，每个端分别分配一个appKey和一个密钥。没有传appKey的请求将报错，传错了appKey的请求也将报错。这样，安全性方面又加多了一层防御，同时也方便对不同端做一些不同的处理策略。

另外，现在越来越多App取消了密码登录，而采用手机号+短信验证码的登录方式，我在当前的项目中也采用了这种登录方式。这种登录方式有几种好处：

不需要注册，不需要修改密码，也不需要因为忘记密码而重置密码的操作了；

用户不再需要记住密码了，也不怕密码泄露的问题了；

相对于密码登录其安全性明显提高了。

显式用户和隐式用户，我不知道这两个词用的是否确切。 

显式用户指的是，APP程序中有用户系统，一个username、password正确的合法用户，称之为显式的用户，

通常显式用户都需要注册，登录以后能完成一些个人相关的操作。

隐式用户指的是，APP程序本身就没有用户系统，或者一个在没有登录的情况下，使用我们APP的用户。

在这种情况下，可以通过客户端生成的UDID来标识一个用户。

有了用户信息，我们就能够了解不同用户的使用习惯，而不仅仅是全体用户的一个整体的统计信息，

有了这些个体的信息之后，就可以做一些用户分群、个性化推荐之类的事情。

如果是SAAS版本，还需要区分不同商户的用户

接口文档有时候是项目初期就定下来的，前后端开发人员按照接口规范开发，

有的是接口开发完成后写的。

接口文档要清晰、明了，包含多少个接口，每个接口的地址、参数、请求方式、数据交换格式、返回值等都要写清楚。

接口测试程序，有条件的话，也可以提供，方便前后端的调试。

如果是springMVC开发的话，可以用swagger，后端只要加几个注释发一个url给前端就可以了，轻松又高效。

在做PC端网站的时候，我们都会给我们的网站加上个统计功能，要么自己写统计系统，要么使用第三方的比如GA、百度等。

移动端接口API则需要我们自己实现统计功能，

这时就需要我们尽可能多的收集客户端的信息，除了传统的IP、User-Agent之外，还应该收集一些移动相关的信息，

比如

手机操作系统，是android还是ios，都是什么版本，

用户使用的网络状况，是2G、3G、4G还是WIFI

客户端APP是什么版本信息。

这样，有助于我们更好的了解我们用户的使用情况。

如何利用Thinkphp框架开发移动端接口详解

方案一：给原生APP提供api接口

使用TP框架时 放在common文件夹下文件名就叫function.php

    
<?php
/**
* Created by zhangkx
* Email: zkx520tnhb@163.com
* Date: 2015/8/1
* Time: 23:15
*/
 
/****** api开发辅助函数 *******/
 
/**
* @param null $msg 返回正确的提示信息
* @param flag success CURD 操作成功
* @param array $data 具体返回信息
* Function descript: 返回带参数，标志信息，提示信息的json 数组
*
*/
function returnApiSuccess($msg = null,$data = array()){
$result = array(
'flag' = 'Success',
'msg' = $msg,
'data' =$data
);
print json_encode($result);
}
 
/**
* @param null $msg 返回具体错误的提示信息
* @param flag success CURD 操作失败
* Function descript:返回标志信息 ‘Error'，和提示信息的json 数组
*/
function returnApiError($msg = null){
$result = array(
'flag' = 'Error',
'msg' = $msg,
);
print json_encode($result);
}
 
/**
* @param null $msg 返回具体错误的提示信息
* @param flag success CURD 操作失败
* Function descript:返回标志信息 ‘Error'，和提示信息，当前系统繁忙，请稍后重试；
*/
function returnApiErrorExample(){
$result = array(
'flag' = 'Error',
'msg' = '当前系统繁忙，请稍后重试！',
);
print json_encode($result);
}
 
/**
* @param null $data
* @return array|mixed|null
* Function descript: 过滤post提交的参数；
*
*/
 
function checkDataPost($data = null){
if(!empty($data)){
$data = explode(',',$data);
foreach($data as $k=$v){
if((!isset($_POST[$k]))||(empty($_POST[$k]))){
if($_POST[$k]!==0  $_POST[$k]!=='0'){
returnApiError($k.'值为空！');
}
}
}
unset($data);
$data = I('post.');
unset($data['_URL_'],$data['token']);
return $data;
}
}
 
/**
* @param null $data
* @return array|mixed|null
* Function descript: 过滤get提交的参数；
*
*/
function checkDataGet($data = null){
if(!empty($data)){
$data = explode(',',$data);
foreach($data as $k=$v){
if((!isset($_GET[$k]))||(empty($_GET[$k]))){
if($_GET[$k]!==0  $_GET[$k]!=='0'){
returnApiError($k.'值为空！');
}
}
}
unset($data);
$data = I('get.');
unset($data['_URL_'],$data['token']);
return $data;
}
}
   
查询单个果品详细信息
 
 
   
/**
* 发布模块
*
* 获取信息单个果品详细信息
*
*/
public function getMyReleaseInfo(){
//检查是否通过post方法得到数据
checkdataPost('id');
$where['id'] = $_POST['id'];
$field[] = 'id,fruit_name,high_price,low_price,address,size,weight,fruit_pic,remark';
$releaseInfo = $this-release_obj-findRelease($where,$field);
$releaseInfo['remark'] = mb_substr($releaseInfo['remark'],0,49,'utf-8').'...';
//多张图地址按逗号截取字符串，截取后如果存在空数组则需要过滤掉
$releaseInfo['fruit_pic'] = array_filter(explode(',', $releaseInfo['fruit_pic']));
$fruit_pic = $releaseInfo['fruit_pic'];unset($releaseInfo['fruit_pic']);
//为图片添加存储路径
foreach($fruit_pic as $k=$v ){
$releaseInfo['fruit_pic'][] = 'http://'.$_SERVER['HTTP_HOST'].'/Uploads/Release/'.$v;
}
if($releaseInfo){
returnApiSuccess('',$releaseInfo);
}else{
returnApiError( '什么也没查到(+_+)！');
}
}
   
findRelease() 方法的model
 
 
   
/**
* 查询一条数据
*/
public function findRelease($where,$field){
if($where['status'] == '' || empty($where['status'])){
$where['status'] = array('neq','9');
}
$result = $this-where($where)-field($field)-find();
return $result;
}
   
app端接收到的数据（解码json之后）
 
 
   
{
"flag": "success",
"message": "",
"responseList": {
"id": "2",
"fruit_name": "苹果",
"high_price": "8.0",
"low_price": "5.0",
"address": "天津小白楼水果市场",
"size": "2.0",
"weight": "2.0",
"remark": "急需...",
"fruit_pic": [
"http://fruit.txunda.com/Uploads/Release/201508/55599e7514815.png",
"http://fruit.txunda.com/Uploads/Release/201508/554f2dc45b526.jpg"
]
}
}
   
app端接收到的数据（原生json串）
代码如下:
{"flag":"success","message":"","responseList":{"id":"2","fruit_name":"\u82f9\u679c","high_price":"8.0","low_price":"5.0","address":"\u5929\u6d25\u5c0f\u767d\u697c\u6c34\u679c\u5e02\u573a","size":"2.0","weight":"2.0","remark":"\u6025\u9700...","fruit_pic":["http:\/\/fruit.txunda.com\/Uploads\/Release\/201508\/55599e7514815.png","http:\/\/fruit.txunda.com\/Uploads\/Release\/201508\/554f2dc45b526.jpg"]}}

方案二：另外我们还可以通过ThinkPHP实现移动端访问自动切换主题模板，这样也可以做到移动端访问

ThinkPHP的模板主题机制，如果只是在PC，只要需修改 DEFAULT_THEME （新版模板主题默认是空，表示不启用模板主题功能）配置项就可以方便的实现多模板主题切换。

但对于移动端与PC端，也许你会设计完全不同的主题风格，且针对不同的来路提供不同的渲染方式，其中一种比较流行的方法是“响应式设计”，但就本人经历而言，要实现完全的“响应式设计”并不是那么容易，且解决兼容问题也是个难题，假设是大型站点，比如：淘宝、百度、拍拍这些，响应式设计肯定是满足不了需求的，而是需要针对手机访问用户提供单独的手机网站。

ThinkPHP 完全能够实现，而且非常的简单。与TPM的智能模版切换引擎相同，只要对来路进行判断处理就行了。

一、将 ismobile() 加入到｛项目/Common/common.php｝

function ismobile() {
// 如果有HTTP_X_WAP_PROFILE则一定是移动设备
if (isset ($_SERVER['HTTP_X_WAP_PROFILE']))
return true;
 
//此条摘自TPM智能切换模板引擎，适合TPM开发
if(isset ($_SERVER['HTTP_CLIENT']) 'PhoneClient'==$_SERVER['HTTP_CLIENT'])
return true;
//如果via信息含有wap则一定是移动设备,部分服务商会屏蔽该信息
if (isset ($_SERVER['HTTP_VIA']))
//找不到为flase,否则为true
return stristr($_SERVER['HTTP_VIA'], 'wap') ? true : false;
//判断手机发送的客户端标志,兼容性有待提高
if (isset ($_SERVER['HTTP_USER_AGENT'])) {
$clientkeywords = array(
'nokia','sony','ericsson','mot','samsung','htc','sgh','lg','sharp','sie-','philips','panasonic','alcatel','lenovo','iphone','ipod','blackberry','meizu','android','netfront','symbian','ucweb','windowsce','palm','operamini','operamobi','openwave','nexusone','cldc','midp','wap','mobile'
);
//从HTTP_USER_AGENT中查找手机浏览器的关键字
if (preg_match("/(" . implode('|', $clientkeywords) . ")/i", strtolower($_SERVER['HTTP_USER_AGENT']))) {
return true;
}
}
//协议法，因为有可能不准确，放到最后判断
if (isset ($_SERVER['HTTP_ACCEPT'])) {
// 如果只支持wml并且不支持html那一定是移动设备
// 如果支持wml和html但是wml在html之前则是移动设备
if ((strpos($_SERVER['HTTP_ACCEPT'], 'vnd.wap.wml') !== false)  (strpos($_SERVER['HTTP_ACCEPT'], 'text/html') === false || (strpos($_SERVER['HTTP_ACCEPT'], 'vnd.wap.wml') < strpos($_SERVER['HTTP_ACCEPT'], 'text/html')))) {
return true;
}
}
return false;
}

二、在｛项目/Lib/｝创建一个 CommonAction.php，假设你的项目已公共控制器，则无需创建，直接加在里面就行了。

Class CommonAction extends Action{
Public function _initialize(){
//移动设备浏览，则切换模板
if (ismobile()) {
//设置默认默认主题为 Mobile
C('DEFAULT_THEME','Mobile');
}
//............你的更多代码.......
}
}

关于移动端接口设计和移动端接口设计规范的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 移动端接口设计的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于移动端接口设计规范、移动端接口设计的信息别忘了在本站进行查找喔。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。