项目介绍
本次项目是一个文章的博客,其功能有用户的登录,查找获取文章,删除文章,编辑评论,查看评论等等,除此之外用户登录时还会获得TOKEN,而用户添加评论时需要进行TOKEN认证。
在本次项目中,我们小组一共6个人,分为前端开发2人与后端开发 4 人,实现项目的服务端和客户端。我在的后端开发小组,主要负责编写登陆和评论相关的api并登陆api的正确性进行测试。我们组内齐心协力地进行工作,同时,也会协助配合前端开发小组的两位同学进行工作,最终小组共同完成这一整个的项目。
具体的工作流程有:
- 选择合适的 API 风格,实现从接口或资源(领域)建模,到 API 设计的过程;
- 使用 API 工具,编制 API 描述文件,编译生成服务器、客户端原型;
- 使用 Github 建立一个组织,通过 API 文档,实现 客户端项目 与 RESTful 服务项目同步开发;
- 使用 API 设计工具提供 Mock 服务,两个团队独立测试 API;
- 使用 travis 测试相关模块。
工作说明
在本次项目中,后端使用了 swagger 生成 API 文档,采用 REST v3 风格,设计了 user, article, comment 三种资源,6 个 API 服务,如下:
{
"SignIn":"/simpleblog/user/signin",
"DeleteArticleById":"/simpleblog/user/deleteArticle/{id}",
"GetArticleById":"/simpleblog/user/article/{id}",
"GetArticles":"/simpleblog/user/articles",
"CreateComment":"/simpleblog/user/article/{id}/comment",
"GetCommentsOfArticle":"/simpleblog/user/article/{id}/comments",
}
并使用 swagger 编辑器 编写 API 文档,语法使用 yaml 语法。
实现效果
- 登陆界面:
- 登陆后进入个人博客列表:
- 删除文章:
- 点进文章查看博文内容:
- 查看博文最底部评论部分:
- 发表一条新的评论:
- 404界面(找不到文章/评论等):
实验心得
在本次项目中,我们经历了前后端分离的开发过程,把人员也分为了前后端,两组同学需要同时工作,相互配合,完成好项目。
这次项目中,我对许多知识掌握的还不太熟练,对项目中需要使用的框架等不太熟悉,因此以免耽误整体的进度,在这次工作中我只承担了比较简单的任务,但我仍然学习了一些知识,收获了经验,并认识到了不足。
而且,我还经历了团队项目的完成,与他人共同完成一个项目,提升了与他人的合作意识。在这次项目的完成过程中,我们虽然有着明确的分工,但每个人在完成自己工作的同时也在配合关照着其他人,我也受到了组内其他成员的许多帮助。而且,组内成员的互相交流更推动了项目整体的前进和完善,每个人的完成和更改也可能会影响到其他人的工作进度,因此组内交流意识也是我的一个收获。