app 后台接口设计（app后端接口）

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

本文目录一览：

• 1、怎么写 App 接口设计方案
• 2、App 和 Web 的通用接口该怎么设计
• 3、APP分页服务端设计
• 4、ios app后台api怎么开发
• 5、手机APP软件开发怎么做？

怎么写 App 接口设计方案

编写接口设计方案头部必定是目录，要是在目录和正文中间插入本方案总设计师姓名和他的手机邮件等联系方式方便双方项目上对接自是极好的
一阐述面向的用户群和平台有哪些；
二要达到怎样的设计目标，如并发量，延迟等；
三设计的系统接口可能会有哪些问题和风险，基于以上，在进行设计过程中将会采用那些技术手段；
四是阐述一些接口命名规范，字段和数据长度限制规范，最大连接时间等；
在后面概述接口按业务或非业务分为哪几大块，订单一块，账户管理一块，日志一块，文件/图片一块；
接下来详述每块分别有哪些接口，具体如何定义的等等；
最后在阐述下整个系统与哪些第三方会有交集，这些接口提供方的公司名字？与这些公司的技术联系人是谁，联系方式是什么，与他们的数据通信方式是什么，他们的访问地址在何处，经过一系列测试后发现的延迟情况，安全问题等等，我方是如何解决的，在本次设计的接口中有哪些用到了这个第三方接口；

App 和 Web 的通用接口该怎么设计

1、在接口定义中确定MVC的GET或者POST方式
由于app 后台接口设计我们整个Web API平台是基于MVC的基础上进行的API开发app 后台接口设计，因此整个Web API的接口，在定义的时候，一般需要显示来声明接口是[HttpGet]或者[HttpPost]，虽然有些接口也可以不用声明，但是避免出现类似下面的错误信息，显式声明还是有好处的。
请求的资源不支持 http 方法“POST
例如在基类定义的查找对象接口如下所示。
/// <summary
/// 查询数据库,检查是否存在指定ID的对象
/// </summary
/// <param name="id"对象的ID值</param
/// <returns存在则返回指定的对象,否则返回Null</returns
[HttpGet]
public virtual T FindByID(string id, string token)
如果是增删改的接口，一般需要声明为POST方式提交数据，而且基于安全性的考虑，需要携带更多的参数。
/// <summary
/// 插入指定对象到数据库中
/// </summary
/// <param name="info"指定的对象</param
/// <returns执行操作是否成功。</returns
[HttpPost]
public virtual CommonResult Insert(T info, string token, string signature, string timestamp, string nonce, string appid)
2、动态对象的接口定义
在一般的Web API接口里面，我们可能都会碰到很多简单类型的参数，但是又想让它们以POST方式提交数据，那么我们就可以有两种方法来处理，一种是定义一个类来放置这些参数，一种是采用动态的JObject参数，前者有很多不方便的地方，因为我们不可能为每个接口参数定义多一个实体类，这样可能会有很多难以管理的类定义。如下面是微信API的调用接口案例，我们也需要设置这样的处理规则。
接口调用请求说明
http请求方式: POST（请使用https协议）
https://api.weixin.qq.com/cgi-bin/groups/update?access_token=ACCESS_TOKEN
POST数据格式：json
POST数据例子：{"group":{"id":108,"name":"test2_modify2"}}
那么我们采用JObject是这么样的呢，我们来看接口的定义和处理代码。JObject是Newtonsoft.Json.Linq命名空间下的一个对象。
/// <summary
/// 修改用户密码
/// </summary
/// <param name="param"包含userName和userPassword的复合对象</param
/// <param name="token"用户访问令牌</param
/// <returns</returns
[HttpPost]
public CommonResult ModifyPassword(JObject param, string token)
{
//令牌检查,不通过则抛出异常
CheckResult checkResult = CheckToken(token);
dynamic obj = param;
if (obj != null)
{
string userName = obj.userName;
string userPassword = obj.userPassword;
bool success = BLLFactory<User.Instance.ModifyPassword(userName, userPassword);
return new CommonResult(success);
}
else
{
throw new MyApiException("传递参数出现错误");
}
}
其中我们把JObject对象转换为我们所需要的对象的时候，因为我们没有定义具体的实体类，因此采用了dynamic语法，声明这是一个动态对象，由运行时获取对应的属性。
dynamic obj = param;
这样我们就可以在调用的时候，动态POST对应的JSON对象给Web API接口，而不需要预先定义各种接口参数的类了。
/// <summary
/// 调用Web API接口，修改用户密码
/// </summary
/// <param name="userName"用户名称</param
/// <param name="userPassword"修改的密码</param
/// <returns如果修改成功返回true，否则返回false</returns
public bool ModifyPassword(string userName, string userPassword)
{
var action = "ModifyPassword";
var postData = new
{
userName = userName,
userPassword = userPassword
}.ToJson();
string url = GetTokenUrl(action);
CommonResult result = JsonHelper<CommonResult.ConvertJson(url, postData);
return (result != null) ? result.Success : false;
}
其中GetTokenUrl是根据token和API的地址等参数，构建一个完整的提交地址。我们在上面代码通过
var postData = new
{
userName = userName,
userPassword = userPassword
}.ToJson();
就可以动态创建一个对象，并生成它的JSON字符串，把数据POST提交到对应的API接口里面即可，然后对结果进行对象的转换就算完成了。
3、集合和分页的处理
在很多接口里面，我们都需要用到分页的处理，Web API也不例外，这样可以提交数据检索效率，减少服务器数据处理的压力，同时也提交客户端的数据显示速度。
一般的集合接口定义如下所示（通用性基类接口）。
/// <summary
/// 返回数据库所有的对象集合
/// </summary
/// <returns指定对象的集合</returns
[HttpGet]
public virtual List<T GetAll(string token)
{
//检查用户是否有权限，否则抛出MyDenyAccessException异常
base.CheckAuthorized(AuthorizeKey.ListKey, token);
List<T list = baseBLL.GetAll();
return list;
}
但是这样的返回记录会比较多，一般情况下需要分页，那么分页的处理接口定义如下所示。
/// <summary
/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)
/// </summary
/// <returns指定对象的集合</returns
[HttpPost]
public virtual PagedList<T FindWithPager(string condition, PagerInfo pagerInfo, string token)
分页接口，在这里返回的结果里面，用了一个PageList的泛型类，这个方便我们获取当前的记录及总数，它的定义如下所示。
/// <summary
/// 分页集合
/// </summary
/// <typeparam name="T"对象</typeparam
public class PagedList<T
{
/// <summary
/// 返回记录的总数
/// </summary
public int total_count { get; set; }
/// <summary
/// 列表集合
/// </summary
public List<T list { get; set; }
}
最后整个分页的处理Web API接口实现如下所示。
/// <summary
/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)
/// </summary
/// <returns指定对象的集合</returns
[HttpPost]
public virtual PagedList<T FindWithPager(string condition, PagerInfo pagerInfo, string token)
{
//检查用户是否有权限，否则抛出MyDenyAccessException异常
base.CheckAuthorized(AuthorizeKey.ListKey, token);
List<T list = baseBLL.FindWithPager(condition, pagerInfo);
//构造成Json的格式传递
var result = new PagedList<T() { total_count = pagerInfo.RecordCount, list = list };
return result;
}
最后客户端调用分页的Web API代码如下所示。
/// <summary
/// 根据条件查询数据库,并返回对象集合(用于分页数据显示)
/// </summary
/// <param name="condition"查询的条件</param
/// <param name="pagerInfo"分页实体</param
/// <returns指定对象的集合</returns
public virtual List<T FindWithPager(string condition, ref PagerInfo pagerInfo)
{
var action = "FindWithPager";
string url = GetTokenUrl(action) + string.Format("condition={0}", condition);
var postData = pagerInfo.ToJson();
List<T result = new List<T();
PagedList<T list = JsonHelper<PagedList<T.ConvertJson(url, postData);
if (list != null)
{
pagerInfo.RecordCount = list.total_count;//修改总记录数
result = list.list;
}
return result;
}
4、混合框架界面整合Web API接口
在整个Web API的平台构建以及在混合框架的整合过程中，我把各个模块还是遵循相对独立的方式进行开发和整合，它们实现了从直接访问数据库、以WCF服务获取数据，以及通过WebAPI调用方式获取数据几种方式的统一，从而实现了整个混合框架的高度整合。
整个混合框架的核心是以相对独立的方式，整合各个可重用的模块，我们可以遵循一定的基础上，快速构建统一的应用平台。
搭建完毕的整个WebAPI平台，其中包括了服务端内容，以API控制器的方式，发布了对应的Web API接口。
在每个混合框架的独立模块里面，我们封装了对应的Web API客户端调用处理，从而实现了Web API的调用方式。
在Win10下，使用Web API模式运行混合框架，获得的主体界面效果如下所示。
独立模块权限管理系统界面如下所示。
系列文章如下所示：
Web API应用架构在Winform混合框架中的应用（1）
Web API应用架构在Winform混合框架中的应用（2）--自定义异常结果的处理
Web API接口设计经验总结
Web API应用架构在Winform混合框架中的应用（3）--Winfrom界面调用WebAPI的过程分解
Web API应用架构在Winform混合框架中的应用（4）--利用代码生成工具快速开发整套应用
Web API应用架构在Winform混合框架中的应用（5）--系统级别字典和公司级别字典并存的处理方式

APP分页服务端设计

web开发中常用的分页方式app 后台接口设计，根据页码进行分页。暂且称为 Web式分页

根据页码 pageIndex 和分页大小 pageSize 进行分页。

这种分页方式app 后台接口设计，在web中使用没有什么太大问题app 后台接口设计，但是在App分页中能否套用这种分页方式呢？

App上的分页方式从表现上看，基本都是上拉加载更多形式的流式分页。如果后台接口仍然按照Web式分页方式进行设计，会有如下问题app 后台接口设计：
a、数据重复

b、数据缺失

c、offset过大时查询效率低
MySQL的limit给分页带来了极大的方便，但数据量一大的时候，limit的性能就急剧下降。
由此可见，传统Web式分页接口并不适合App分页。
3、App流式分页服务端设计

a、cursor游标式分页

优点app 后台接口设计：
1)、能够避免数据重复/遗漏
2)、limit性能不会cursor数值大小影响，性能稳定
缺点：
1)、适用于只是按照时间追加的方式的简单排序

b、按照时间分片缓存
非全量数据，只是部分热门数据，因为数据变化太快，可以基于时间段生成多个缓存。对于数据可以按时间段（5分钟）生成一个缓存分片。
具体流程如下：

此处的timestamp值，请求第1页数据时，timestamp传0，服务端检查timestamp<=0，就将当前系统时间赋值给timestamp返回，请求第2，3，...n页数据时，将系统返回的timestamp传入。
缓存的key是根据timestamp进行计算的，比如5分钟一个分片，key=list_201605231700。

应用场景

比如首页热门，只是一些热门文章，排序有一定的复杂性，且相对容易变动。

目前专题中列表排序是按照点赞数排序的，分页请求

出现了重复的数据，是因为该排序是实时数据，且没有游标，无法感知前面加载的数据。

c、id列表一次性下发给App
1、请求第一页数据之前先缓存所有id列表
2、请求每页数据时，只需带入相关的id列表参数

这种方式适用于id列表不会很大（数百条数据）的业务场景，例如腾讯新闻。

ios app后台api怎么开发

关于API的设计与实现

API的设计是软件开发中一个独特的领域。

特殊点在于API是供开发者使用的界面，即Application Programmer Interfaces。类似于用户可以直接使用到的GUI的作用一样。所以相对于依据软件设计的原则，考虑用户的”体验”会更加重要。

狭义上API可能只是一个动态库（共享库）提供功能的接口定义。广义上API分为public API，以及internal API之分。既有整体软件系统对外输出的接口（包括与设备通讯的接口），也有系统内一个底层模块提供给上层模块使用的接口定义。

对于一般的开发任务，常常思考的是保证功能的正确性和设计的完美，可以不断尝试做创新和重构。但这些原则放到API设计上就不一定正确了，反而需要有些保守。

手机APP软件开发怎么做？

1、首先你要有一个idea，app开发，就是一个把想法转换为具体产品的过程。

2、然后项目经理先大方向把控，对项目进行评估，比如风险多少，可行性多大，成本预算多少和市场上存在同类型产品分析。还要了解用户对竞品app的感受和需求。确定app面向的客户类型，市场份额，和需要实现的功能。

3、产品经理上场，进行用户调研，做用户画像，定义用户标签。再进行需求分析，功能设计，交互设计，流程设计，确定项目框架，输出需求文档和产品原型图，交接给UI工程师。

4、UI将产品原型图设计、渲染、细分，输出页面设计图，页面坐标图和切图。

5、开发人员根据需求文档，产品原型图和页面页面设计图开始代码编写。前端开发(Android与IOS)负责前端页面布局，接口处理和本地逻辑编写。后台开发人员负责数据库设计，代码编写以及和前端接口对接。

6、测试人员根据需求写测试用例，开发人员修改程序BUG，直至异常全部处理，开始准备上架。

7、上架之前，产品经理需要申请各大应用商店的登录账号，按照平台要求上传app的安装包和文案图片。

8、运营推广上线后的app，运营人员正式开始推广，付费免费的渠道也有很多。

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

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