首页 > 其他 > 详细

后端技术规格说明书

时间:2015-11-04 00:33:09      阅读:302      评论:0      收藏:0      [点我收藏+]

1.技术概览

开发环境 Ubuntu 14.04.2
数据库 MySQL
后端开发框架 rails 4.0
前后端交互 前端发送HTTP请求,后端捕获request,进行路由匹配,返回json格式数据

 

 

 

 


 

2.功能框架

  • 普通用户与社团用户的登录系统
  • 展示社团发布的活动信息
  • 社团编辑并发布自己的活动信息
  • 普通用户报名参加发布的活动,并添加相关备注
  • 社团用户获取参加活动的所有普通用户名单,并对名单中的用户进行删除操作

 

3.API设计

   3.1 API功能分类

        3.1.1 用户登录系统

技术分享

          3.1.2 报名

技术分享

          3.1.3 活动文章增删改

技术分享

            3.1.4 前端获取文章信息

技术分享

           3.1.5 活动名单

技术分享

    3.2 路由搭建

 

HTTP 方法 路径 控制器#动作 作用
POST /api/register users#register 普通用户注册
POST /api/users/login users#login 普通用户登录
GET /api/users/logout users#logout 普通用户登出
POST /api/clubs/login clubs#login 社团用户登录
GET /api/clubs/:uid/articles/:page_id clubs#getabstracts 获取社团文章概要
GET /api/clubs/logout clubs#logout 社团用户登出
GET /api/articles/:page_id articles#abstracts 获取文章概要
GET /api/articles/detail/:article_id articles#detail 获取文章详情
POST /api/clubs/articles/detail/create articles#create 创建文章
POST /api/clubs/articles/detail/:article_id/change articles#show 返回文章
POST /api/clubs/articles/detail/:article_id/update articles#update 编辑文章
POST /api/clubs/articles/detail/:article_id/delete articles#destroy 删除文章
POST /api/clubs/articles/detail/:article_id/list articles#list 获取参与活动名单
POST /api/clubs/articles/detail/:article_id/list/delete articles#cutlist 删除活动名单
POST api/users/:uid/articles/:article_id/notes/create notes#create 创建备注(报名)

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 


 

4.后端数据库设计

       4.1 数据表

表名 属性名 类型 属性含义
articles id integer 主键
club_id integer 外键,与club实体建立多对一关联
title string 文章标题
abstract string 文章摘要
content string 文章内容
created_at string 表建立时间
updated_at string 表更新时间
users id integer 主键
stu_num integer 学号
password string 密码
phone_num string(11) 学生联系电话
log_num integer 状态验证码
created_at string 表建立时间
updated_at string 表更新时间
clubs    id integer 主键
name string 社团名称
password string 社团帐号密码
introduction string 社团介绍
head_url string 社团头像存储url地址
log_num integer 状态验证码
created_at string 表建立时间
updated_at string 表更新时间
notes id integer 主键
content string 备注内容
user_id integer 外键,指向users表
article_id integer 外键,指向articles表
created_at string 表建立时间
updated_at string 表更新时间

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

4.2 E-R图概念模型 

技术分享

             


 

5.错误处理:

状态码 错误 返回错误信息
401 普通用户账户信息认证失败 Invalid User
401 社团用户账户信息认证失败  Invalid club 
404 数据表中没有该记录  NoRecord error 
404 创建记录失败  New record failed
404 更新记录失败  update failed 
404 删除记录失败 destroy failed

 

 

 

 

 

 

 

后端技术规格说明书

原文:http://www.cnblogs.com/wowotoubuaa/p/4934565.html

(0)
(0)
   
举报
评论 一句话评论(0
关于我们 - 联系我们 - 留言反馈 - 联系我们:wmxa8@hotmail.com
© 2014 bubuko.com 版权所有
打开技术之扣,分享程序人生!