盗亦有道：如何来评审接口文档

评审一项东西，首先是要你自己心理有谱，需要评审那些点，所以评审本质是评审两样东西：第一，该有的点是否都有；第二，这些点是否达到了要求。

在评审接口文档的时候，需要评审：

1.接口参数是否足够，要知道参数本质就是描摹接口，所以参数应该是对一个接口方法的一个很好的说明；场景是否都满足；参数的描述是否足够具体，便于他人了解；

2.返回值是否足够；返回参数的描述是否具体，便于他人了解；

3.错误返回是否全面；

4.示例是否准确，清晰。