如何给app写接口

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

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

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

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

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

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

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

② 用thinkphp写一个app登录的接口 麻烦哪位大神给个事例

1、可以使用 REST模式 来开发 App 接口，首先建立一个公共控制器，再建其他控制器继承它即可。
2、确定好返回的数据内容格式及信息码；

<?php

// App接口公共控制器 AppController

namespace Api\Controller;

use Think\Controller\RestController;

class AppController extends RestController {

// 自动加载的东西

function _initialize() { }

// 验证 客户端 token

protected function checkAppToken($apptoken){

// 引入 function.php 中定义的检测 apptoken 的函数

if(checkingAppToken($apptoken)){

return true;

}else{

$data['code'] = '404';

$data['msg'] = 'apptoken无效';

$data['data'] = null;

$this -> response($data, 'json');

exit();

}

}

// 验证 用户 token

protected function checkUserToken($usertoken){

}

// 各种验证 ……

}

?>
复制代码

其他接口控制器继承 AppController

<?php

// 内容控制器 ContentsController

namespace Api\Controller;

class ContentsController extends AppController {

// 自动加载验证

function _initialize() {

parent::_initialize();

// 验证 客户端 token

$apptoken = I('post.apptoken');

parent::checkAppToken($apptoken);

// 验证 用户 token

$usertoken = I('post.usertoken');

parent::checkUserToken($usertoken);

// 各种需要验证的验证 ……

}

// 各种业务方法

public function index(){

// 返回数据

$this -> response($data, 'json');

exit();

}

}

?>

③ app移动接口开发需要注意什么

1.制定规范

开发前一定要定好一个规范，比如要定好数据返回的通用参数和格式。关于数据格式，用的比较多的有xml和json，我建议用json，因为json比xml的好处更多。

2.精简的返回数据

接口数据因符合需要什么返回什么的原则，比如要查询某个用户的余额和注册时间，网页禅洞里面的做法可能是select * from user where uid=1，但是接口一定要select balance,regtime from user where uid=1。因为接口返回数据是要有开销的，要流量的，能少返回数据就尽量少返回，这样可以大大的提高性能。

3.数据类型要严格

要注意数据的类型，整数类型的数据一定要转为int，因为app客户端开发的java、object-c语言对数据类型比较严格，类型不对会照成app闪退。

4.要写接口文档

一定要写好接口文档，并按照模块写，而且还要书写规范，最好的格式是：
接口请求地址；请求参数（包括参数名、类型、是否必填）；测试参数举例；返回参数（参数名，并注明每个参数的含义）。
这样哪怕以后项目很大，以不会照成维护困难的问题。

5.保证代码正确性

要验证保证代码正确无误，而且生成环境中要屏蔽掉错误，避免头部有额外的输出，照成返回的json等数据解析失败而导致app闪退等。

6.要优化代码的性能

app要求响应迅速，这样才能给用户比较好的体验感。所以移动接口端在处理业务逻辑的时候，要避免不要执行太复杂的sql语句，或者含有大量的循环，能做成缓存的尽量做颂档缓存，比如将首页的热点模块信息可以存到redis缓存中。在不考虑网速的情况下，比较理想的接口响应时间应该是200毫秒以内。

7.不要随意更改旧接口

app不像网页，app一旦发布，有人使用之后，接口就不要乱修改了。以后升级也是，修改要在保证接口原有结构之野袭乱上进行额外的扩展，否则会导致调用旧版接口的app出现bug。

8. 注意接口的安全

安全高于一切，必须要保证接口的安全。电话号码等敏感信息在传输的过程中一定要加密，否则可能会被别人抓包到。拿取用户信息的接口一定要验证权限，以防止接口被恶意调用，泄密用户信息，甚至篡改信息。

以上只是一些基础注意事项，真正要完成一个项目，得注意很多很多，其中的点点滴滴都需要谨慎对待，这些需要在开发中慢慢体会、总结。

④ 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）--系统级别字典和公司级别字典并存的处理方式

⑤ 如何利用postman做app接口测试

1、在Google已安装完成的接口测试工具的postman的程序之后，点击进入桌面的chrome应用启动器。

⑥ 如何为自己的App搭建后台Api接口

如果你是使用的VC (Visual Studio C++)的话，也是有与VB类似的工具箱来拖放控件的，对于一般的应用程序，推荐基于MFC来开发。--这意味着你需要再学习一些新的东西，如果你只是处于学习C语言的阶段，这没有必要这样。 如果你是使用的Turbo C之类的，因为那个年代很多系统还是DOS的字符界面，所以基本上没有好的工具来作GUI界面，需要自己编辑资源文件来创建Win32的界面，需要比较熟悉win32的api。对于简易的界面而言，这是可行的，复杂点的，还是使用VC比较好。