【实训】第一周总结下

来源:互联网 发布:apache服务器下载64位 编辑:程序博客网 时间:2024/05/29 09:04

最近做了以下工作:设计接口文档

由于项目要前后端分离,后台提供接口,前端通过调用接口和用户交互,前后端独立并行开发,所以需要有一个双方协定好的接口文档,就类似于Java中的接口,只声明可以做什么,具体的时候后期进行,上次设计好了数据库,这次的主要任务就是设计好基础功能的接口文档。以下是具体的接口文档:

全局约定:
返回值形式:{status:(请求的状态),message:(一个简单短语解释状态码),data:{返回的数据object}}
状态码: 200表示请求成功
300 表示请求失败
400 表示没有权限
所有涉及到分页的URL,统一请求参数:
page:第几页
rows:每页多少个
所有返回有/无的接口,返回值统一是{success:m} m可取值为0,1 其中0代表失败1代表成功
全局约定中声明好的返回数据,在本文档中具体接口中留空
旅游和近程接口类似,不再重复声明,规定Tourism更换为Close,参数中加上type即为近程接口
-----------------------------------------------------------------------------
用户相关:
统一使用/user前缀
登录:
login[post]
参数:
id 手机号
password 密码
返回值:
注册:
registered[post]
参数:
id 手机号
password 密码 (重复密码在前端进行验证)
返回值
检查用户名是否存在:
exists[get]
参数:
id 手机号
返回值
设置基本信息:
userInfo[post]
参数:
username 昵称
location 所在地
返回值
实名认证:
realName[post]
参数:
userId 身份证号(前端进行有效验证)
查看自己报名的旅游信息:
userTourism[get]
参数:
返回值:
[{id 唯一标示 int(9) 自增
 userId 发布者id
         departure 出发地
 destination 目的地
 existPeople 已有人数
   planPeople 计划人数
     departureTime 出发时间
 returnTime 返回时间
 budget 旅游预算
 transportation 交通工具
 publishTime 发布时间
 detailed 详细信息
 valid 是否有效}]
-----------------------------------------------------------------------------
常规业务:
统一使用/user/common前缀
发布旅游信息:
addTourism[post]
参数:
departure 出发地 varchar(44)
destination 目的地 varchar(44)
planPeople 计划人数 int(9)
departureTime 出发时间 TIMESTAMP
returnTime 返回时间 TIMESTAMP
budget 旅游预算 varchar(10)
transportation 交通工具 varchar(10)
detailed 详细信息 varchar(255)
返回值:
获取旅游信息:
getTourisms[get]
参数:
返回值:
[{id 唯一标示 int(9) 自增
 userId 发布者id varchar(11) 
         departure 出发地 varchar(44)
 destination 目的地 varchar(44)
 existPeople 已有人数 int(9)
   planPeople 计划人数 int(9)
     departureTime 出发时间 TIMESTAMP
 returnTime 返回时间 TIMESTAMP
 budget 旅游预算 varchar(10)
 transportation 交通工具 varchar(10)
 publishTime 发布时间 TIMESTAMP
 detailed 详细信息 varchar(255)}]
报名旅游信息:
applyTourism[post]
参数:
id 要报名的旅游
返回值:
删除旅游信息:
deleteTourism[post]
参数:
id 要删除的旅游
返回值