从“零”搭建酒店项目（5）API 设计

从“零”搭建酒店项目（5）API 设计

这是一个前后端分离的项目，在我们的数据库基本定型后就可以愉快的设计 API（因为请求和响应的数据与数据库是直接关联的）
本次项目没有采用 RESTful 风格。

API 文档规范

1. 请求方式只用 GET/POST
2. 请求路径按照任务分配表上的写
3. GET 请求的参数在 Query 里面填写，POST 在 Body 里写。不要混用
4. 不要使用 RESTFul 的路径传参
5. 环境的使用：
   1. 不要使用环境变量，目前用不上
   2. 只使用一个环境 url 前缀即可（协议+ip+端口）
   3. 已有的环境可以直接用，但是不要改，因为这是公用的。如果有需求自己建一个环境即可。
6. 请求参数规范：以下
7. 参数名采用驼峰命名
8. 数据库中存在的字段的参数，命名要保持一致
9. 如果参数中用多个 id 参数，必须区分命名，且要与数据库一致
10. 传参的实例值尽量真实一点
11. 类型要选择正确，类型的选项很多自己看看。
12. 参数描述简练准确
13. 响应数据示例的格式必须的实际的格式
14. 响应数据的类型和描述和请求参数的要求一致
15. 金额数据：后端使用整数存，但是到了前端部分要转化为小数（类型为Number）

其他问题

1. api 项目的目录结构已经更新了！请小伙伴按照任务分配把自己负责的接口移动到相应的位置
2. 由于api项目不能容纳所有伙伴导致部分人没有进入项目进行编辑。所以至少要保证共同开发接口的伙伴中至少一个人能进入编写，如果不能可以请技术队长代为写入。