app接口设计规范（app一般接口用什么协议）

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

本文目录一览：

• 1、怎么写 App 接口设计方案
• 2、App 和 Web 的通用接口该怎么设计
• 3、什么是接口文档,如何写接口,有什么规范?
• 4、App接口需求文档
• 5、PHP---APP接口02

怎么写 App 接口设计方案

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

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

1、在接口定义中确定MVC的GET或者POST方式
由于我们整个Web API平台是基于MVC的基础上进行的API开发，因此整个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）--系统级别字典和公司级别字典并存的处理方式

什么是接口文档,如何写接口,有什么规范?

含义是：在项目开发中，web项目的前后端分离开发，APP开发，需要由前后端工程师共同定义接口，编写接口文档，之后大家都根据这个接口文档进行开发，到项目结束前都要一直维护。

目的是：项目开发过程中前后端工程师有一个统一的文件进行沟通交流开发。项目维护中或者项目人员更迭，方便后期人员查看、维护。

规范是：以/a开头，如果需要登录才能调用的接口(如新增、修改；前台的用户个人信息，资金信息等)后面需要加/u，即：/a/u；中间一般放表名或者能表达这个接口的单词；get方法，如果是后台通过搜索查询列表，那么以/search结尾，如果是前台的查询列表，以/list结尾；url参数就不说了。

API（Application Programming Interface，应用程序接口）是一些预先定义的接口（如函数、HTTP接口），或指软件系统不同组成部分衔接的约定。用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程，而又无需访问源码，或理解内部工作机制的细节。

应用程序接口又称为应用编程接口，是一组定义、程序及协议的集合，通过 API接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。

API同时也是一种中间件，为各种不同平台提供数据共享。程序设计的实践中，编程接口的设计首先要使软件系统的职责得到合理划分。良好的接口设计可以降低系统各部分的相互依赖，提高组成单元的内聚性，降低组成单元间的耦合程度，从而提高系统的可维护性和可扩展性。

App接口需求文档

1.接口地址：
2.支持格式：json
3.请求方式：post
4.请求参数：

| 名称 | 类型 | 必填 |说明|
| -------- |:------:|: -----:|:--------:|
| mobile | string | 是 |手机号|
|password | string | 是 |密码|
| nickname| string | 是 |昵称|
| smsCode| string | 是 |验证码|
5.返回字段说明：

6.返回JSON实例

1.接口地址：
2.支持格式：json
3.请求方式：post
4.请求参数：

| 名称 | 类型 | 必填 |说明|
| -------- |:------:|: -----:|:--------:|
| mobile | string | 是 |手机号|

5.返回字段说明：

1.接口地址：
2.支持格式：json
3.请求方式：post
4.请求参数：

| 名称 | 类型 | 必填 |说明|
| -------- |:------:|: -----:|:--------:|
| mobile | string | 是 |手机号|
|password | string | 是 |密码|
5.返回字段说明：

6.返回JSON实例

1.接口地址：
2.支持格式：json
3.请求方式：delete
4.请求参数：session_id
5.返回字段说明：

6.返回JSON实例

1.接口地址：
2.支持格式：json
3.请求方式：post
4.请求参数：

| 名称 | 类型 | 必填 |说明|
| -------- |:------:|: -----:|:--------:|
| page | string | 是 |页码|

5.返回字段说明：

6.返回JSON实例

1.接口地址：
2.支持格式：json
3.请求方式：post
4.请求参数：

| 名称 | 类型 | 必填 |说明|
| -------- |:------:|: -----:|:--------:|
| page | string | 是 |页码|
| type | string | 是 |商品类型|

5.返回字段说明：

6.返回JSON实例

1.接口地址：
2.支持格式：json
3.请求方式：post
4.请求参数：

| 名称 | 类型 | 必填 |说明|
| -------- |:------:|: -----:|:--------:|
| ID | string | 是 |商品ID|

5.返回字段说明：

6.返回JSON实例

1.接口地址：
2.支持格式：json
3.请求方式：post
4.请求参数：

| 名称 | 类型 | 必填 |说明|
| -------- |:------:|: -----:|:--------:|
| page | string | 是 |页码|

5.返回字段说明：

6.返回JSON实例

1.接口地址：
2.支持格式：json
3.请求方式：post
4.请求参数：

| 名称 | 类型 | 必填 |说明|
| -------- |:------:|: -----:|:--------:|
| type | string | 是 |订单类型|
5.返回字段说明：

6.返回JSON实例

1.接口地址：
2.支持格式：json
3.请求方式：post
4.请求参数：

| 名称 | 类型 | 必填 |说明|
| -------- |:------:|: -----:|:--------:|
| consignee | string | 是 |收货人|
| telephone_num | string | 是 |收货人电话|
| address | string | 是 |收货地址|
| goods_id | string | 是 |商品编号|
| goods_num | string | 是 |商品数量|
| order_price | string | 是 |订单金额|
| charges | string | 是 |运费|

5.返回字段说明：

6.返回JSON实例

1.接口地址：
2.支持格式：json
3.请求方式：post
4.请求参数：

| 名称 | 类型 | 必填 |说明|
| -------- |:------:|: -----:|:--------:|
| goods_id | string | 是 |商品编号|
| content | string | 是 |评论内容|
| score | string | 是 |评分|
| images | array | 否 |图片链接|

5.返回字段说明：

6.返回JSON实例

1.接口地址：
2.支持格式：json
3.请求方式：get
4.请求参数：
4.请求参数：

| 名称 | 类型 | 必填 |说明|
| -------- |:------:|: -----:|:--------:|
| goods_id | string | 是 |商品编号|
| page | string | 是 |页码|
5.返回字段说明：

6.返回JSON实例

PHP---APP接口02

JSONXML

XML: 是一种标记语言app接口设计规范，设计app接口设计规范的宗旨是传输数据

JSONapp接口设计规范： 轻量级的数据交换格式

APP接口主要是用JSON输出格式

APP接口输出格式三要素app接口设计规范：

1. code:：错误码

2. msg：错误码对应的描述

3. data：接口返回的数据

谁有权限调用APP接口，客户端需要带着凭证来调用APP接口

JWT的原理：

服务端认证之后，生成一个JSON对象，返回给用户。后续客户端所有请求都会带上这个JSON对象。服务端依靠这个JSON对象来认定用户身份。

组成: Header, Payload, Signature

1. Header

说一下我是什么

header通常包含app接口设计规范了两部分：类型和加密算法

{

    "alg": "HS256",

    "typ": "JWT"

}

header需要经过Base64Url编码后作为IWT的第一部分。

2. Payload

payload包含了claim, 三种类型reserved, public, private

reserved这些claim是JWT预先定义的，不强制使用，常用的有：

1). iss: 签发者

2). exp: 过期的时间戳

3). sub: 面向的用户

4). aud: 接收方

5). iat: 签发时间

{

    "sub":  "1234567890",

    "name":  "John Doe",

    "admin": true

}

payload需要经过Base64Url编码后作为JWT的第二部分。

3. Signature

创建签名使用编码后的header和payload以及一个密匙，使用header中指定的签名算法进行签名

HMACSHA256(

base64UrlEncode(header) + "." +

base64UrlEncode(payload),

secret

)

签名是在服务端进行的，客户端并不知道，所以是安全的。

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

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