为什么要写API接口文档？
-有利于客户端工程师熟悉接口
-有利于服务端工程师接手项目
需要包含哪些内容？
-API接口地址
-请求方式 get put post delete
-入参格式
-出参格式
-http code
例如 ： https://www.showdoc.com.cn/
简要描述
- 用户注册接口
请求URL
http://xx.com/api/user/register
请求方式
- POST
参数
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| username | 是 | string | 用户名 |
| password | 是 | string | 密码 |
| name | 否 | string | 昵称 |
返回示例
{"error_code": 0,"data": {"uid": "1","username": "12154545","name": "吴系挂","groupid": 2 ,"reg_time": "1436864169","last_login_time": "0",}}
返回参数说明
| 参数名 | 类型 | 说明 |
|---|---|---|
| groupid | int | 用户组id，1：超级管理员；2：普通用户 |
备注
- 更多返回错误代码请看首页的错误代码描述