【SaaS云会议系统开发】项目实训——2021.07.02

【SaaS云会议系统开发】项目接口文档编写

编写“我的会议”相关的接口文档

1.接口文档规范

状态码code规范：
200：成功
300：token失效，登录失效
500：失败

1. 采用restful风格撰写接口文档
2. url为资源，最好是名词，分词使用下划线
3. method有4种，对应不同的请求参数格式
   a. get：查询数据，请求参数为query params，不需要设置header中的content-type
   b. post：添加数据，请求参数为body params，需要设置header中的content-type
   c. put：修改数据，请求参数为body params，需要设置header中的content-type
   d. delete：删除数据，请求参数为query params，不需要设置header中的content-type
4. 接口的response body格式，数据放在data属性中噢

2.我的会议接口编写

总结

接口编写并不困难，但是需要对应的规范，同时需要与项目成员的协作沟通能力，我充分感受到了一个项目运作的复杂和合理管理的重要性。