Report

Final Report

课程学习总结

在这次课程作业中，我是后端开发的成员，主要负责API接口的设计、API文档的编写、部分路由功能的实现以及API接口的验收和测试。

我觉得API接口的设计是一项十分重要的工作，它关于前后端对接的标准，是前后端分离开发的基础和依据。同时这项工作也有一定的难度，以为设计API接口需要对整个项目需求十分清晰，而且要仔细分析前后端的交互逻辑，功能上要完备，形式上要符合规范，还要兼顾安全性和可扩展性。但是由于软件需求的复杂性和易变性，在项目初期设计的API接口是不太可能一次到位的，实际也是在开发的过程中不断完善。除了开发上的困难，沟通前后端的开发人员，协商一致的接口也是十分耗时的，也需要良好的沟通和协调能力。

PSP2.1表格

PSP2.1	Personal work stage	Time(%)
*Planning	计划需要学习的技术和知识	10
Estimate	估算各项工作所需的时间	10
*Development	开发	75
Analysis	需求分析	20
Design Spec	生成设计文档	12
estimate	前后端成员一起审核设计文档	5
coding standard	代码规范	5
design	具体设计如UI设计，架构设计等	10
coding	编码开发	10
code review	代码审查	5
test	测试debug	8
*Report	报告	15
test report	测试报告	7
size measurement	计算工作量	2
postmortem & process improvement plan	迭代完成后总结文档，并提出改进	6

主要工作

1. 学习swagger、postman等api设计工具的使用,学习OpenAPI3标准并使用该标准编写API，生成文档供前后端使用。
2. 实现部分API接口，协助设计数据库结构。
3. 学习使用API的自动化测试方法，对团队成员实现的API进行验收和测试。

• 最得意的工作：将远离啊后台的数据库异步访问带来的回调地狱的代码结构，重构为可读性强、符合同步代码阅读习惯的async、await写法。
• 最有价值的工作：设计功能完善的API接口，成为前后端可以分离开发的基础。
• 最有苦劳的工作：后期对API的测试和DEBUG，是一项繁重的工作，需要考虑很多，而且很细致。

个人git log贡献总结

• Dashboard文档仓库贡献

• BackEnd后端代码贡献

个人博客清单

用OpenAPI3在SwaggerHub编写API接口文档

特别致谢

感谢团队的每一位成员ZTao-z、huangjundashuaige、EmilyBlues、wkfdb、qingyunhuohuo、wei49、sherluck314、ddghost在开发的过程中都尽心尽力完成各自的任务，而且在开发过程中互帮互助，使我学习到很多，收获了很多。