android 开发 ------- 接口文档规范

时间：2014-11-04 21:14:02 阅读：182 评论：0 收藏：0 [点我收藏+]

1 接口书写的格式：

1 用例图

2 流程图

3 具体的接口：

3.1请求的方式：
包括：
服务器地址 le.gxjinan.com/open/user.php?ac=login
请求方式 POST
编码格式 UTF-8
内容的格式 application/x-www-form-urlencoded

3.2 请求的参数：
例如：
参数类型是否必须说明
user String 是手机号，邮箱，用户名

3.2 响应信息：
请求方式 POST
编码格式 UTF-8
数据类型 Json 数据实体，包含msg对象。
内部包含的注册成功后用户的ID!

3.3 返回的数据:

返回的正确信息

整体的Json 数据，

详细的Json数据，

返回错误的信息