怎么寫接口文檔

接口文檔

1、用戶登錄-- post /user/login/

請求參數 類型 是否必填 參數位置 說明
username 字符串 消息體 用戶名
password 字符串 消息體 用戶名

響應信息 登陸成功: {

"code":200,

"message":"登陸成功",

"token":"123456789" ? }

登錄失?。? {

"code":403,

"message":"登陸失敗", ? }

2.用戶注冊 --post /user/register

請求參數 類型 是否必填 參數位置 說明
user_name 字符串 消息體 用戶名
pass_word 字符串 消息體 用戶名
user_tel 字符串 消息體 電話
user_full_name 字符串 消息體 用戶真實姓名
user_sex 字符串 消息體 用戶性別
user_birth 字符串 消息體 用戶出生
user_email 字符串 消息體 用戶郵箱
user_photo 字符串 消息體 用戶頭像

響應信息 注冊成功 狀態碼:200 { "user_name": "張三",

"user_tel": "13697552828",

"user_full_name": "李四",

"user_sex": 男,

"user_birth": "2000/1/1",

"user_email": "123456789@qq.com",

"user_photo": "" ? } 注冊失敗 狀態碼:403 ? {

"detail":"注冊信息有誤"

}

3.添加文章 post /article/add_article

請求參數 類型 是否必填 參數位置 說明
token 字符串 請求頭 用戶身份認證
article_title 字符串 消息體 文章主題
article_content 字符串 消息體 文章內容
article_put_time 字符串 消息體 發布時間
article_pic 字符串 消息體 圖片
article_day 字符串 消息體 旅游天數
article_per_cost 字符串 消息體 花費
article_go_time 字符串 消息體 出發時間

響應內容 成功狀態碼:200 { "article_title": "游記標題",

"article_content": "游記內容",

"article_put_time": "發布時間",

"article_pic": "圖片",

"article_put_time": "發布時間",

"article_day": "出行天數",

"article_per_cost": "花費",

"article_go_time": "出發時間"

} 失敗狀態碼:403 ? {

"detail":"未提供身份認證信息"

} 失敗狀態碼:404 ? {

"detail":"當前用戶沒有操作權限 "

} 4.更新文章 -- PUT updata_article

請求參數 類型 是否必填 參數位置 說明
token 字符串 請求頭 用戶身份認證
article_title 字符串 消息體 文章主題
article_content 字符串 消息體 文章內容
article_put_time 字符串 消息體 發布時間
article_pic 字符串 消息體 圖片
article_day 字符串 消息體 旅游天數
article_per_cost 字符串 消息體 花費
article_go_time 字符串 消息體 出發時間
article_good_count 字符串 消息體 好評
article_bad_count 字符串 消息體 差評

成功狀態碼:200 {

"article_id":""

"user_id":[{

"user_name":"用戶名字",

}],

"location_id":[{

"location_name":"地區名字",

}],

"article_title": "文章主題",

"article_content": "文章攻略內容",

"article_pic": "圖片",

"article_put_time": "出發時間",

"article_day": "旅游天數",

"article_go_time": "出發時間",

"article__good_count": "好評數",

"article_bad_count": "差評數",

"article_per_cost": "花費"

}

失敗狀態碼:403

{

"detail":"未提供身份認證信息"

}

失敗狀態碼:404 {

"detail":"當前用戶沒有操作權限 "

} 5.刪除文章--DELETE /article/del_article

請求參數 類型 是否必填 參數位置 說明
token 字符串 請求頭 用戶身份認證

成功狀態碼:200 {

"message":"刪除成功"

} 失敗狀態碼:403 ? {

"detail":"未提供身份認證信息"

} 失敗狀態碼:404 ? {

"detail":"當前用戶沒有操作權限 "

} 6.查詢文章--GET /article/get_article

請求參數 類型 是否必填 參數位置 說明
article_title 字符串 查詢參數 文章主題
article_content 字符串 查詢參數 文章內容
page 整數 查詢參數 頁碼
size 整數 查詢參數 頁面大小

成功狀態碼:200 {

"next":"上一頁",

"previous":"下一頁",

"result"[{

"article_id":""

"user_id":[{

"user_name":"用戶名字",

}],

"location_id":[{

"location_name":"地區名字",

}],

"article_title": "文章主題",

"article_content": "文章攻略內容",

"article_pic": "圖片",

"article_put_time": "出發時間",

"article_day": "旅游天數",

"article_go_time": "出發時間",

"article__good_count": "好評數",

"article_bad_count": "差評數",

"article_per_cost": "花費"

}] ? } 7.查詢地區--GET /common/location/ 請求參數:無 響應信息 ? { ? "location_id":"",

"country_id":[

"country_name":"國家",

]

"location_name": "地區名字",

"location_info": "地區介紹",

"location_pic": "地區圖片",

"location_room": "周邊住宿",

"location_eat": "周邊飯店"

} 8.景點查詢--GET /common/sights/ 請求參數:無 響應信息 ? {

"sight_id":"",

"location_id":[{

"location_name":"景區地區"

}]

"varible_id":[{

"varible_name":"類型"

}]

"sight_name": "景區名字",

"sight_pic":"圖片",

"sight_food": "景區美食",

"sight_ticket": "門票",

"sight_info": "景區介紹"

} 9.添加私人訂制--POST /vip/add_vip/

請求參數 類型 是否必填 參數位置 說明
token 字符串 請求頭 用戶身份認證
vip_go_date 字符串 消息體 訂制出發時間
vip_back_date 字符串 消息體 訂制返回時間
vip_pop 字符串 消息體 訂制旅游人數
vip_info 字符串 消息體 訂制信息描述
vip_tel 字符串 消息體 用戶電話
vip_real_name 字符串 消息體 用戶真實姓名
varible_id 字符串 消息體 出游類型
service_id 字符串 消息體 服務類型
hotel_id 字符串 消息體 酒店類型

響應信息 成功狀態碼:200 { "vip_id":"",

"vip_go_date": "出發時間",

"vip_back_date": "返回時間",

"vip_pop": "人數",

"vip_info": "訂制信息",

"vip_tel": "用戶電話",

"vip_real_name": "真實姓名",

"varible_id": [

{

"varible_name": "出游類型名稱"

}

],

"service_id": [

{

"service_type": "服務類型",

"service_info": "服務描述"

} ? ], ? "hotel_id": [ ? { ? "hotel_type": "酒店類型" ? } ? ], ? } 失敗狀態碼:403 ? { ? "detail":"未提供身份認證信息" ? } 失敗狀態碼:404 ? { ? "detail":"當前用戶沒有操作權限 " ? } 10.刪除私人訂制--DELETE /vip/del_vip/

請求參數 類型 是否必填 參數位置 說明
token 字符串 請求頭 用戶身份認證

響應信息 成功狀態碼:200 { "message":"刪除成功" } 失敗狀態碼:403 { "detail":"未提供身份認證信息" } 失敗狀態碼:404 { "detail":"當前用戶沒有操作權限 " } 11.修改私人訂制--PUT /vip/updata_vip

請求參數 類型 是否必填 參數位置 說明
token 字符串 請求頭 用戶身份認證
vip_go_date 字符串 消息體 訂制出發時間
vip_back_date 字符串 消息體 訂制返回時間
vip_pop 字符串 消息體 訂制旅游人數
vip_info 字符串 消息體 訂制信息描述
vip_tel 字符串 消息體 用戶電話
vip_real_name 字符串 消息體 用戶真實姓名
varible_id 字符串 消息體 出游類型
service_id 字符串 消息體 服務類型
hotel_id 字符串 消息體 酒店類型

響應信息 成功狀態碼:200 { "vip_id":"", "vip_go_data": "出發時間", "vip_back_data": "返回時間", "vip_pop": "人數", "vip_info": "訂制信息", "vip_tel": "用戶電話", "vip_real_name": "真實姓名", "varible_id": [ { "varible_name": "出游類型名稱" } ], "service_id": [ { "service_type": "服務類型", "service_info": "服務描述" } ], "hotel_id": [ { "hotel_type": "酒店類型" } ], } 失敗狀態碼:403 { "detail":"未提供身份認證信息" } 失敗狀態碼:404 { "detail":"當前用戶沒有操作權限 " } 12.查看私人訂制--PUT /vip/get_vip

請求參數 類型 是否必填 參數位置 說明
vip_real_name 字符串 查詢參數 文章主題
vip_tel 字符串 查詢參數 文章內容
page 整數 查詢參數 頁碼
size 整數 查詢參數 頁面大小

響應信息 { "next":"上一頁", "previous":"下一頁", "reault"[{ "vip_id":"", "vip_go_data": "出發時間", "vip_back_data": "返回時間", "vip_pop": "人數", "vip_info": "訂制信息", "vip_tel": "用戶電話", "vip_real_name": "真實姓名", "varible_id": [ { "varible_name": "出游類型名稱" } ], "service_id": [ { "service_type": "服務類型", "service_info": "服務描述" } ], "hotel_id": [ { "hotel_type": "酒店類型" } ], }] } 13.服務類型--GET /vip/service/ 請求參數:無 響應信息 { "service_ic":"", "service_type": "服務類型", "service_pic": "圖片", "service_info": "服務介紹" } 14.查詢酒店--GET /vip/hotel/ 請求參數:無 響應信息 { "hotel_id":"", "hotel_type": "酒店類型", "hotel_pic": "圖片", "hotel_info": "酒店介紹" } 15.國家安全--GET /vip/countries/ 請求參數:無 響應信息 { "country_id":"", "country_name": "國家名字", "country_issafe": "是否安全" } 16.添加組隊信息--POST /team/add_team

請求參數 類型 是否必填 參數位置 說明
token 字符串 請求頭 用戶身份認證
team_title 字符串 消息體 組隊標題
team_tel 字符串 消息體 聯系電話
team_sex 字符串 消息體 性別要求
team_pop 字符串 消息體 組隊人數
team_info 字符串 消息體 組隊簡介
team_put_date 字符串 消息體 發起組隊消息時間
team_out_data 字符串 消息體 組隊消息失效時間

響應信息 成功狀態碼:200 { "team_id":"", "team_title": "西藏游", "team_tel": "13012345678", "team_sex": "性別不限", "team_pop": "5人", "team_put_date": "2000/5/5", "team_info": "自駕游,先到先得", "team_out_data": "2000/5/10" } 失敗狀態碼:403 { "detail":"未提供身份認證信息" } 失敗狀態碼:404 { "detail":"當前用戶沒有操作權限 " } 17.修改組隊信息--PUT /team/updata_team

請求參數 類型 是否必填 參數位置 說明
token 字符串 請求頭 用戶身份認證
team_title 字符串 消息體 組隊標題
team_tel 字符串 消息體 聯系電話
team_sex 字符串 消息體 性別要求
team_pop 字符串 消息體 組隊人數
team_info 字符串 消息體 組隊簡介
team_put_date 字符串 消息體 發起組隊消息時間
team_out_data 字符串 消息體 組隊消息失效時間

響應信息 成功狀態碼:200 { "team_id":"", "team_title": "西藏游", "team_tel": "13012345678", "team_sex": "性別不限", "team_pop": "5人", "team_put_date": "2000/5/5", "team_info": "自駕游,先到先得", "team_out_data": "2000/5/10" } 失敗狀態碼:403 { "detail":"未提供身份認證信息" } 失敗狀態碼:404 { "detail":"當前用戶沒有操作權限 " } 18.刪除組隊信息--DELETE /team/del_team

請求參數 類型 是否必填 參數位置 說明
token 字符串 請求頭 用戶身份認證

響應信息 成功狀態碼:200 { "message":"刪除成功" } 失敗狀態碼:403 { "detail":"未提供身份認證信息" } 失敗狀態碼:404 { "detail":"當前用戶沒有操作權限 " } 19.查看組隊信息--GET /team/get_team

請求參數 類型 是否必填 參數位置 說明
team_title 字符串 查詢參數 組隊主題
team_info 字符串 查詢參數 組隊簡介
page 整數 查詢參數 頁碼
size 整數 查詢參數 頁面大小

響應信息 { "next":"上一頁", "previous":"下一頁", "result":[{ "team_id":"", "team_title": "西藏游", "team_tel": "13012345678", "team_sex": "性別不限", "team_pop": "5人", "team_put_date": "2000/5/5", "team_info": "自駕游,先到先得", "team_out_data": "2000/5/10" }] } 20.舉報原因--POST /common/report_reason/

請求參數 類型 是否必填 參數位置 說明
token 字符串 請求頭 用戶身份認證
reason_typ 字符串 消息體 舉報類型

響應信息 成功狀態碼:200 { "reason_id":"", "reason_type": "舉報類型" } 失敗狀態碼:403 { "detail":"未提供身份認證信息" } 失敗狀態碼:404 { "detail":"當前用戶沒有操作權限 " } 21.--出游類型--POST /common/variable/

請求參數 類型 是否必填 參數位置 說明
token 字符串 請求頭 用戶身份認證

響應信息 成功狀態碼:200 { "variable_id":"", "variable_name": "海邊" } 失敗狀態碼:403 { "detail":"未提供身份認證信息" } 失敗狀態碼:404 { "detail":"當前用戶沒有操作權限 " } 22.舉報組隊--POST /common/team_report/

請求參數 類型 是否必填 參數位置 說明
token 字符串 請求頭 用戶身份認證
reason_id 字符串 消息體 舉報原因
team_id 字符串 消息體 舉報隊伍

響應信息 成功狀態碼:200 { "team_report_id":"", "reason_id": [ { "reason_type": "廣告" } ], "team_id": 1, "team_report_info": "廣告文,無實用" } 失敗狀態碼:403 { "detail":"未提供身份認證信息" } 失敗狀態碼:404 { "detail":"當前用戶沒有操作權限 " } 23.黑名單--GET /common/black_type/ 請求參數:無 響應信息 { "black_type": "禁言7天" }

?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,936評論 6 535
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,744評論 3 421
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事?!?“怎么了?”我有些...
    開封第一講書人閱讀 176,879評論 0 381
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,181評論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,935評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,325評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,384評論 3 443
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,534評論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,084評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,892評論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,067評論 1 371
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,623評論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,322評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,735評論 0 27
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,990評論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,800評論 3 395
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,084評論 2 375

推薦閱讀更多精彩內容