技术规格说明书
| 项目 | 内容 |
|---|---|
| 班级：2020春季计算机学院软件工程(罗杰 任健) | 博客园班级博客 |
| 作业：团队项目选择 | 技术规格说明书 |
| 我们在这个课程中的目标 | 写出令客户和自己都满意的代码同时变得更强 |
| 这个作业对我们实现目标的帮助 | 技术功能规格制定与说明 |
概述
整体架构
API规格（暂定）
博问部分API
| 名称 | 请求方式 | 请求地址 | 描述 |
|---|---|---|---|
| askQues | POST | https://api.cnblogs.com/api/questions | 在博问中提问 |
| answerQues | POST | https://api.cnblogs.com/api/questions/{questionId}/answers?loginName={"XXX"} | 回答博问 |
| getAnswerList | GET | https://api.cnblogs.com/api/questions/{questionId}/answers | 获得单个问题的回答列表 |
| deleteAnswer | DELETE | https://api.cnblogs.com/api/questions/{questionId}/answers/{answerId} | 删除回答 |
| getQuesByType | GET | https://api.cnblogs.com/api/questions/@{type}?pageIndex={pageIndex}&pageSize={pageSize} | 根据类型获取问题列表 |
| modifyQues | PATCH | https://api.cnblogs.com/api/questions/{questionId} | 修改问题 |
| getHomepageQues | GET | https://api.cnblogs.com/api/questions/@sitehome?pageIndex={pageIndex}&pageSize={pageSize} | 获得首页问题列表 |
| getQuesDetail | GET | https://api.cnblogs.com/api/questions/{questionId} | 获得单个问题详情 |
首页部分API
| 名称 | 请求方式 | 请求地址 | 描述 |
|---|---|---|---|
| getBlogContent | GET | https://api.cnblogs.com/api/blogposts/{id}/body | 获取博文内容 |
| getEssenceBlog | GET | https://api.cnblogs.com/api/blogposts/@picked?pageIndex={pageIndex}&pageSize={pageSize} | 分页获取精华区博文列表 |
| getHomePageBlog | GET | https://api.cnblogs.com/api/blogposts/@sitehome?pageIndex={pageIndex}&pageSize={pageSize} | 分页获取网站首页博文列表 |
| blogPostComments | POST | https://api.cnblogs.com/api/blogs/{blogApp}/posts/{postId}/comments | 添加博文评论 |
| blogPostCommentsList | GET | https://api.cnblogs.com/api/blogs/{blogApp}/posts/{postId}/comments?pageIndex={pageIndex}&pageSize={pageSize} | 获取博文的评论列表 |
| searchBlog | Get | https://api.cnblogs.com/api/ZzkDocuments/{category}?keyWords={keyWords}&pageIndex={pageIndex}&startDate={startDate}&endDate{endDate}&viewTimesAtLeast={viewTimesAtLeast} | 搜索博文 |
| getPersonalBlogList | Get | https://api.cnblogs.com/api/blogs/{blogApp}/posts?pageIndex={pageIndex} | 获取个人博文 |
动态部分API
| 名称 | 请求方式 | 请求地址 | 描述 |
|---|---|---|---|
| getLatestStatuses | GET | https://api.cnblogs.com/api/statuses/recent | 获取最新一条动态内容 |
| publishStatuses | POST | https://api.cnblogs.com/api/statuses | 发布动态 |
| getStatusesById | GET | https://api.cnblogs.com/api/statuses/{id} | 根据id获取动态 |
| getStatusesByType | GET | https://api.cnblogs.com/api/statuses/@{type}?pageIndex={pageIndex}&pageSize={pageSize}&tag={tag} | 根据类型获取动态列表 |
班级部分API
| 名称 | 请求方式 | 请求地址 | 描述 |
|---|---|---|---|
| getClass | GET | https://api.cnblogs.com/api/edu/member/schoolclasses | 获取用户班级列表 |
| getClassInformation | GET | https://api.cnblogs.com/api/edu/schoolclass/{schoolClassId} | 根据id获取班级信息 |
| getHomeworkInformation | GET | https://api.cnblogs.com/api/edu/homework/{homeworkId} | 根据id获取作业信息 |
| getNoticeInformation | GET | https://api.cnblogs.com/api/edu/bulletin/{bulletinId} | 根据id获取公告信息 |
| getClassBlogs | GET | https://api.cnblogs.com/api/edu/schoolclass/posts/{filter}/{schoolClassId}/{pageIndex}-{pageSize} | 分页获取班级博客列表 |
| getClassNotice | GET | https://api.cnblogs.com/api/edu/schoolclass/bulletins/{schoolClassId}/{pageIndex}-{pageSize} | 分页获取班级公告列表 |
| getClassHomework | GET | https://api.cnblogs.com/api/edu/schoolclass/homeworks/{withoutPostponed}/{schoolClassId}/{pageIndex}-{pageSize} | 分页获取班级作业列表 |
| getClassMember | GET | https://api.cnblogs.com/api/edu/schoolclass/members/{schoolClassId}?filter={filter} | 分页获取班级成员列表 |
我的部分API
| 名称 | 请求方式 | 请求地址 | 描述 |
|---|---|---|---|
| getUserMessage | GET | https://api.cnblogs.com/api/users | 获取当前登录用户信息 |
| editCollection | PATCH | https://api.cnblogs.com/api/bookmarks/{id} | 修改用户的收藏 |
| addCollection | POST | https://api.cnblogs.com/api/Bookmarks | 添加用户的收藏 |
| getCollectionList | GET | https://api.cnblogs.com/api/Bookmarks?pageIndex={pageIndex}&pageSize={pageSize} | 分页获取收藏列表 |
| deleteCollection | DELETE | https://api.cnblogs.com/api/bookmarks/{id} | 根据id删除收藏 |
| getPersonalEssayList | GET | https://api.cnblogs.com/api/blogs/{blogApp}/posts?pageIndex={pageIndex} | 获取个人博客随笔列表 |
| getPersonalBlogMessage | GET | https://api.cnblogs.com/api/blogs/{blogApp} | 获取个人博客信息 |
| getBlogContent | GET | https://api.cnblogs.com/api/blogposts/{id}/body | 获取博文内容 |
| getClassHomeworkList | GET | https://api.cnblogs.com/api/edu/schoolclass/homeworks/{withoutPostponed}/{schoolClassId}/{pageIndex}-{pageSize} | 分页获取班级作业列表 |