老师的API文档是用什么工具写的？

Answer 1

大目 2019-09-10 22:36:35

您好，用Swagger管理文档，不是本套课程的内容哈。

简单来说，分为三步：

用Swagger生成swagger的API路径，例如：localhost:8081/v2/api-docs

使用使用swagger2markup-maven-plugin插件，生成ASCIIDOC文件；

使用asciidoctor-maven-plugin，将ASCIIDOC文件转换成HTML。

过程还是比较复杂的。

详细步骤，可详见手记：http://www.itmuch.com/other/doc-generate/

• 提问者 张小鱼0 #1

  swagger有个问题就是将文档和本身的程序都放在一起了，这样会莫名造成程序变大，这种方式真的适合生产环境吗？

• 大目 回复 提问者 张小鱼0 #2

  目前swagger是最流行的api管理工具。

• 提问者 张小鱼0 回复 大目 #3

  哦，了解了

Answer 2

大目 2019-09-11 11:42:08

如果不喜欢把文档和代码耦合在一起，可以尝试Swagger Editor：https://swagger.io/tools/swagger-editor/

此外，文档管理系统/软件有很多，都能达到管理文档的目的，例如：

• RAP：https://github.com/thx/RAP

• ApiDoc：http://apidocjs.com/

• RAP2：https://github.com/thx/rap2-delos

• YApi：https://github.com/YMFE/yapi
  

还有很多其他的……只要你愿意，你甚至可以自己用markdown写，或者用Gitbook写，都OK。