為什么寫接口文檔，好處是什么？

答：方便日后項(xiàng)目上線，直接把接口文檔甩給前端，讓前端訪問指定的接口地址，得到對(duì)應(yīng)的json數(shù)據(jù)

格式如下：

好客租房前端接口 v1.0

作者：張凱

郵箱：aaa@aa.com

說明：接口采用restful規(guī)范

時(shí)期：2020-08-18

版本：1.0版本

公共資源

賬號(hào)申請(qǐng)

賬號(hào)和密碼是通過聯(lián)系官方人員進(jìn)行開通，開通后會(huì)得到賬號(hào)和密碼
聯(lián)系人：aaaa@aaa.com

接口域名

// 接口地址
https://www.xmmc.com/api/v1

一、用戶登錄

uri

https://www.xmmc.com/api/v1/login

請(qǐng)求方式

下面代碼我是用laravel框架舉例子的

Route::group(['middleware'=>'auth:api','prefix'=>'v1','namespace'=>'Api'],function (){
    // 接口登錄
    Route::post('login','Api\LoginController@login');
});

請(qǐng)求參數(shù)（參數(shù)說明）

post請(qǐng)求體中傳遞數(shù)據(jù)

返回值（參數(shù)信息）

json 格式

{
    "expire": 7200,
    "token": "eyJ0eXAiOiJKV"
}

錯(cuò)誤碼

二、獲取用戶信息

uri

請(qǐng)求方式

請(qǐng)求參數(shù)

返回值

錯(cuò)誤碼

注：和用戶登錄接口信息基本相似