为什么写接口文档,好处是什么?
答:方便日后项目上线,直接把接口文档甩给前端,让前端访问指定的接口地址,得到对应的json数据
格式如下:
好客租房前端接口 v1.0
公共资源
账号申请
接口域名
// 接口地址
https://www.xmmc.com/api/v1
一、用户登录
uri
https://www.xmmc.com/api/v1/login
请求方式
下面代码我是用laravel框架举例子的
Route::group(['middleware'=>'auth:api','prefix'=>'v1','namespace'=>'Api'],function (){
// 接口登录
Route::post('login','Api\LoginController@login');
});
请求参数(参数说明)
字段名 |
类型 |
说明 |
username |
string |
账号 |
password |
string |
密码 |
返回值(参数信息)
字段名 |
类型 |
说明 |
expire |
int |
有效期 单位 秒 |
token |
string |
登录的token值 |
{
"expire": 7200,
"token": "eyJ0eXAiOiJKV"
}
错误码
错误码 |
说明 |
1000 |
用户名或密码不正确 |
1001 |
用户名或密码没有传递 |
二、获取用户信息
uri
请求方式
请求参数
返回值
错误码
注:和用户登录接口信息基本相似