接口文档 HTML,附录1：接口文档参考模板

虽然提供了在线接口参数的查看，但在和客户端对接过程中，我们作为后台开发，还是需要人工提供接口文档给客户端的，这里提供一个接口文档编写的模板，以供参考，并且以我们熟悉的?service=User.GetBaseInfo为例说明如何编写高效的文档。

温馨提示：斜体字表示是注释说明。

功能说明

对接口功能的简单说明。

获取用户的基本信息。

接口URL

请求的相对链接和当前接口级参数，通常为?service=XXX.XXX + 公共接口参数。

/demo/?service=User.GetBaseInfo

对当前接口级参数的说明，建议使用在线接口参数查询工具，但以下的参数说明也是需要的。参数名字是否必须说明示例userId用户ID是表示用户的ID&user_iduser_id=1

返回参数

对当前接口级返回参数的说明，即对{"ret":返回状态码,"data":"应该业务数据","msg":"错误提示"}中的data部分进行说明。{

"ret": 200,

"data": {

"code": 0, //code=0表示正确获取用户信息，code=1时表示用户不存在

"msg": "", //业务提示文案

"info": { //仅当code=0的情况下非空且有用户信息

"id": "1", //用户ID

"name": "dogstar", //用户名

"note": "oschina" //用户来源

}

"msg": ""

}

示例

至少应包括成功示例，失败示例可选

成功示例

请求：http://phalapi.oschina.mopaas.com/Public/demo/?service=User.GetBaseInfo&user_iduser_id=1

返回：{

"ret": 200,

"data": {

"code": 0,

"msg": "",

"info": {

"id": "1",

"name": "dogstar",

"note": "oschina"

}

"msg": ""

}

接口文档 HTML,附录1：接口文档参考模板相关推荐

python api接口生成_Django 自动生成api接口文档教程
最近在写测试平台,需要实现一个节点服务器的api,正好在用django,准备使用djangorestframework插件实现. 需求实现一个接口,在调用时,通过传递的参数,直接运行对应项目的自动化 ...
java接口文档生成工具_接口文档生成
一.为什么要写接口文档? 1.正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要. 2.项目开发过程中前后端工程师有一个统一的文件进行沟通 ...
python 美团api接口对接_美团券对接API文档
美团券验证平台接入文档 1 接入步骤 2 验证流程 3 接口设计 3.0 说明 3.0.1 sign计算方法: 3.0.2 测试用的app_key,sign_key和美团券密码: 3.1 M1接口: ...
java扫描接口_一种扫描接口并生成可调用API接口文档的方法与流程
本发明属于JavaWeb开发技术领域,涉及一种API接口文档的生成方法,尤其是一种扫描接口并生成可调用API接口文档的方法. 背景技术: API(Application Programming Int ...
java接口注释_Java的注释和API文档
Java 语言的注释一共有三种类型: 单行注释多行注释文档注释一.单行注释和多行注释单行注释就是在程序中注释一行代码,在 Java 语言中,将双斜线(//)放在需要注释的内容之前就可以了 : ...
webservice 根据文档使用apipost测试接口
webservice 例如:根据文档使用apifox测试接口文章目录 webservice 一.获取webservice接口文档二.使用步骤 1.打开apiPost设置Header参数.url参数 ...
根据接口文档书写接口，并在前端调用接口返回显示出数据（加下载）
---恢复内容开始--- 1.首先来看接口文档(其中一个接口): 接口的编写: 1 /** 2 * 7.11 余额明细查询接口3 *4 *@paramtoken5 *@parampageNum6 * ...
接口文档如何编写，接口文档快速生成工具
正规的团队合作或者是项目对接,接口文档是非常重要的,一般接口文档都是通过开发人员写的.一个工整的文档显得是非重要.下面我总结下自己看到的优秀接口文档. 一.背景介绍接口:API API(Applic ...
什么是接口的幂等性，如何实现接口幂等性？一文搞定
微信搜索<Java鱼仔>,每天一个知识点不错过每天一个知识点什么是接口的幂等性,如何实现接口幂等性? (一)幂等性概念幂等性原本是数学上的概念,用在接口上就可以理解为:同一个接口,多 ...
php接口含义,php晋级必备：一文读懂php接口特点和使用！
PHP接口与类是什么关系? 前面提到了php中抽象类和抽象方法,今天给大家谈谈php中接口技术.在PHP中每个类只能继承一个父类,如果声明的新类继承了抽象类实现了以后,这个新类就不能有其它的父类了.但 ...

接口文档 HTML,附录1：接口文档参考模板

接口文档 HTML,附录1：接口文档参考模板相关推荐

最新文章

热门文章