2回答

大目

2019-09-10

已采纳

您好，用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/

1

3

张小鱼0

回复

大目

哦，了解了

2019-09-10

共3条回复

大目

2019-09-11

如果不喜欢把文档和代码耦合在一起，可以尝试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。

0

0