大多数情况下,开发的接口都不是给开发这个接口的人用的,所以如果没有接口文档,别人就无法有哪些接口可以调用,即使知道了接口的 URL,也很难知道接口需要哪些参数,即使知道了这些参数,也可能无法理解这些参数的含义。因此接口文档应该是项目必不可少的配置。 编写接口文档有很多种方式,最为简单直接的方式就是打开一个记事本或者 word 文档,将接口的详细信息和用法写下来,别人就可以参考这个文档来调用接口。这样做虽然简单,但弊端也很明显:一是需要写大量的描述文字,非常枯燥,但其实这些信息在代码中已有体...