Jerry‘s word

本文中的关键词 “必须（MUST）”、“禁止（MUST NOT）”、“必要（REQUIRED）”、“应当（SHALL）”、“不应当（SHALL NOT）”、“应该（SHOULD）”、“不应该（SHOULD NOT）”、“推荐（RECOMMENDED）”、“可以（MAY）” 和 “可选（OPTIONAL）” ，其相关解释参考。

一般前后端分离项目会拥有不同的数据格式，例如 json、url等。这里要通过文档的形式同前后端一起确定好数据阐述的格式。接口地址：不包含接口BASE地址。请求方式: get、post、put、delete等。请求参数：数据格式（默认json）、数据类型、是否必填、中文描述。响应参数：类型、中文描述。这里的接口文档一般就是对应后台的实体，即RequestVo（调用后台接口访问的实体）和给往前端的ResponseVo（前台调用接口时前往的实体）。