怎么写接口文档

接口文档

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天" }