优雅的生成接口文档

apidoc是一个简单的RESTful API文档生成器

是一款可以由源代码中的注释直接自动生成api接口文档的工具，它几乎支持目前主流的所有风格的注释。可以在C#, Go, Dart, Java, JavaScript, PHP, TypeScript等语言中使用。它对代码没有侵入性，只需要写好相关的注释即可，并且它仅通过写简单的配置就可以生成高颜值的api接口页面。它基于Node.js的，所以需要安装Node.js环境

检查是否安装Node.js命令是npm -v 如果已经安装就会输出版本号，如果没有安装则会输出错误信息“不是内部或外部命令” ，需要安装Node.js。下载地址为 http://node.js.org/zh-cn/

node.js我安装的是这个版本

使用npm下载依赖时，由于是从国外的网站上下载内容，所以可能经常会出现不稳定的情况，所以需要下载cnpm代替npm，cnpm是国内淘宝的做的，在国内使用稳定。

1.下载cnpm

npm install -g cnpm --registry=https://registry.npm.taobao.org

 2.检查apidoc是否安装成功：

apidoc -h

 这样就代表安装成功，接下来在你的spring boot项目的根路径下创建apidoc.json（注：一定要是根目录下创建apidoc.json）

 

 参数详细说明

 

然后在你的controller方法上使用注释注解具体的注释说明请查阅

apiDoc 详解 api接口文档生成_Dom_留声机的博客-CSDN博客_apidocPHP使用apiDoc api接口文档安装apidocapidoc 命令参数列表配置(apidoc.json)apidoc.json配置项apidoc注释参数@api@apiErrorExample@apiDefine@apiDeprecated@apiDescription@apiError@apiExample@apiGroup@apiParam@apiHeader@apiHeaderExam...https://blog.csdn.net/qq_14824885/article/details/87793476

 

最后生成接口文档，需要在你项目的外面一层使用 apidoc -i apidocdemo/ -o apidoc-demo-doc/

命令生成接口文档  -i参数表示输入的路径，-o参数表示输出的路径 执行完成之后 apidoc-demo-doc就是生成的接口文档

apidocdemo是我的项目名 

 打开apidoc-demo-doc就是生成的接口文档 里面有index.html