怎么写接口文档

接口文档

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阅读 212,294评论 6赞 493
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,493评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 157,790评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,595评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,718评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 49,906评论 1赞 290
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,053评论 3赞 410
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,797评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,250评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,570评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,711评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,388评论 4赞 332
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,018评论 3赞 316
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,796评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,023评论 1赞 266
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,461评论 2赞 360
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,595评论 2赞 350

推荐阅读更多精彩内容