API接口模板接口文档模板下载资源.docVIP

API接口模板

API接口模板

API接口模板

/**＊＊*＊*＊＊*＊＊＊**＊＊＊＊****＊该部分一个文档只有一个即可***＊＊＊*＊******＊****＊*＊

说明

字段名称

字段说明

Msg

请求接口的结果，成功还是失败

Message

请求接口返回的具体信息（提交成功、获取失败)

ResultCode

请求接口返回的结果码

Info

请求接口返回的结果集，所需的具体值

参数填写说明:Y---—必须，N——-非必须

接口前缀:①测试地址：/”/

历史记录：

编辑人

编辑时间

编辑内容描述

杨宪稳

2018。03。0110:00

创建模板

杨宪稳

2018。03。0110:17

增加历史记录说明

注意：一个项目一个文档。

****＊*＊*＊＊＊*＊**＊**＊＊*该部分一个文档只有一个即可＊＊＊****＊＊*＊＊*＊**＊＊＊＊*＊＊**＊*＊＊＊/

演示方法文档

接口名称

登录

请求地址

/api/Account/DemoMethod

请求方式

POST

返回值类型

json

功能描述

该接口用于移动端登录使用……（一定要清晰的描述接口功能）

参数名

参数说明

参数类型

是否必填

Id

用户Id

int

Y

传递参数

{

Id:1

}

返回结果

｛

”Msg”:true,

Message:操作成功，

”ResultCode:10000，

Info：{

Account”：admin”，

Phone：”1246552”,

”RealName：”管理员,

Email”：”ddddddddd@

｝

｝