虽然提供了在线接口参数的查看，但在和客户端对接过程中，我们作为后台开发，还是需要人工提供接口文档给客户端的，这里提供一个接口文档编写的模板，以供参考，并且以我们熟悉的?service=User.GetBaseInfo为例说明如何编写高效的文档。 _温馨提示：斜体字表示是注释说明_。 ##功能说明 _对接口功能的简单说明。_ 获取用户的基本信息。 ##接口URL _请求的相对链接和当前接口级参数，通常为?service=XXX.XXX + 公共接口参数。_ /demo/?service=User.GetBaseInfo ## [参数说明](http://phalapi.oschina.mopaas.com/Public/demo/checkApiParams.php?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": "" } ```