apidoc——自动生成go语言api文档

简介

apidoc 是一个简单的 RESTful API 文档生成工具，它从代码注释中提取特定格式的内容，生成文档。

目前支持支持以下语言：C#、C/C++、D、Dart、Erlang、Go、Groovy、Java、JavaScript、Julia、Kotlin、Lisp/Clojure、Lua、Nim、Pascal/Delphi、Perl、PHP、Python、Ruby、Rust、Scala、Swift、Typescript 和 Zig。

下载、安装apidoc

我们可以从以下网址下载主流系统下的二进制文件

https://github.com/caixw/apidoc/releases

假如没有找到对应系统的安装压缩包，则需要
1.下载 Go；
2.下载源代码，git clone github.com/caixw/apidoc；
3.执行代码中 build/build.sh 或是 build/build.cmd 进行编译；
4.编译好的文件存放在 cmd/apidoc 下，可以将该文件放置在 PATH 目录；

本文以ubuntu20.04举例
首先我们下载linux文件

下载完后在其目录下进行解压

tar -zxvf apidoc_7.2.0_linux_amd64.tar.gz

然后将其生成的apidoc可执行文件copy到$GOPATH/bin的目录下

这样我们就安装完成apidoc了

使用apidoc生成api文档

安装完apidoc后，我们就可以转移到我们go文件目录下
使用apidoc detect 生成配置文件

然后再使用apidoc build 生成xml文件，也就是我们的api文档。

其中也许会有报错，但是apidoc会自动将报错部分删除，不写入文档

看到如图所示提示，则我们的文档已经自动生成
具体内容如下图所示：

具体的格式可以参考如下网址
apidoc

https://apidoc.tools/