神刀安全网

推荐REST API文档构建工具

互联网公司都是迭代开发,基本上都是缺乏文档,这就导致了不少问题。

  1. 除了开发的人知道,其他人不明白。有一些是业务上的逻辑,仅仅看代码是看不出来原因,为什么需要这么做。
  2. 通常一个接口,不仅后端开发人员知道,调用人员,前端人员,QA同学以及后进来的同学,也需要明白,每一个接口是做什么的。
  3. 我们需要知道理解每一个接口的参数,可能性值,以及成功与报错的不同的返回等。

我的原则是别人开源的东西,能用的,就不自己写,除非有一些不满足自己的需要,那就修改别人的或者自己搞一个。

我推荐这款http://apidocjs.com/ 工具,非常不错。

  1. 只需要在每一个接口前面,写一下注释就可以。
  2. 注释里面包含着接口的用途,参数,返回值等。
  3. 可以将生成的文档,生成到一个服务器下面,可以通过网络,每一个人都可以看到。

转载本站任何文章请注明:转载至神刀安全网,谢谢神刀安全网 » 推荐REST API文档构建工具

分享到:更多 ()

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址
分享按钮