前端定义接口文档

前言：为什么需要前端去定义接口文档呢。

1. 后端的接口文档不一定是靠谱的。他们使用的swagger文档，有的时候是针对某个字段只是表示一个对象，但是对象里有哪些字段就没有了。
2. 后端提供的接口文档，请求参数是否必填不明确；响应参数给的字段太多了。而我们需要的参数却只有几个。

前端的接口文档要求：

1. 请求参数字段和响应字段，只写前端需要的字段。中文描述名先填好，英文字段名后面填写（如果后端给的文档不明确，直接让后端填）。
2. 请求参数字段 需要 表明 是否必填，是否条件存在，

标签：必填,前端,接口,字段,参数,文档
来源： https://www.cnblogs.com/wfblog/p/16247099.html