接口文档写法

来源:互联网 发布:变量被优化掉 编辑:程序博客网 时间:2024/06/07 08:16
接口说明:xx网站注册用的接口
请求方式:get/post
请求地址:www.api.com/api.php
请求参数:
参数名
说明
是否必须
action
调用的那个接口
 
name
用户名
 
pwd
密码
 
callback
回调方法
 
retype
返回值类型
xml或json 默认为json
返回值:
参数名
说明
是否一定返回
code
状态码
content
提示信息
请求实例:http://www.api.com/api.php?action=register&callback=show&name=1234&pwd=123
返回实例:show{"code":"200","content":"success"}
状态码说明:

更新日志: 2017年8月16日 xxx编写v1.0版本
2017年8月16日 xxx编写v1.0版本
更新内容 入库密码改为MD5加密

原创粉丝点击