Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/caixw/apidoc
RESTful API 文档生成工具，支持 Go、Java、Swift、JavaScript、Rust、PHP、Python、Typescript、Kotlin 和 Ruby 等大部分语言。
https://github.com/caixw/apidoc
api apidoc document documentation-generator go golang rest rest-api rest-api-documentation restful restful-api tools
Last synced: 2 months ago
JSON representation
RESTful API 文档生成工具，支持 Go、Java、Swift、JavaScript、Rust、PHP、Python、Typescript、Kotlin 和 Ruby 等大部分语言。
- Host: GitHub
- URL: https://github.com/caixw/apidoc
- Owner: caixw
- License: mit
- Created: 2015-07-16T11:09:18.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-07-26T03:57:41.000Z (over 1 year ago)
- Last Synced: 2024-08-03T17:18:46.587Z (6 months ago)
- Topics: api, apidoc, document, documentation-generator, go, golang, rest, rest-api, rest-api-documentation, restful, restful-api, tools
- Language: Go
- Homepage: https://apidoc.tools
- Size: 3.51 MB
- Stars: 847
- Watchers: 47
- Forks: 108
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-golang-repositories - apidoc
README
# apidoc
[](https://github.com/caixw/apidoc/actions?query=workflow%3ATest)
[](https://github.com/caixw/apidoc/releases/latest)
[](https://goreportcard.com/report/github.com/caixw/apidoc)
[](https://codecov.io/gh/caixw/apidoc)
[](https://pkg.go.dev/github.com/caixw/apidoc/v7)
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。
具体文档可参考：
```go
/**
*
*
*
*
*
* user
* users
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
func login(w http.ResponseWriter, r *http.Request) {
// TODO
}
```
## 使用
macOS 和 linux 可以使用 homebrew 安装：
```shell
brew tap caixw/brew
brew install caixw/brew/apidoc
```
同时在 提供了部分主流系统下的可用二进制。
如果你使用的系统不在此列，则需要手动下载编译：
```shell
git clone https://github.com/caixw/apidoc.git
cd apidoc
./scripts/build.sh
```
支持多种本地化语言，默认情况下会根据当前系统所使用的语言进行调整。也可以通过设置环境变更 `LANG` 指定一个本地化信息。*nix 系统也可以使用以下命令：
```shell
LANG=lang apidoc # lang 设置为你需要的语言 ID，比如 zh-hans 等。
```
具体的安装和使用细节可参考 。
## 集成
若需要将 apidoc 当作包集成到其它 Go 程序中，可参考以下代码：
```go
import (
"golang.org/x/text/language"
"github.com/caixw/apidoc/v7"
"github.com/caixw/apidoc/v7/core"
"github.com/caixw/apidoc/v7/build"
)
// 初始本地化内容
apidoc.SetLocale(language.MustParse("zh-Hans"))
// 可以自定义实现具体的错误处理方式
h := core.NewHandler(...)
output := &build.Output{...}
inputs := []*build.Input{...}
apidoc.Build(h, output, inputs...)
```
具体可查看文档：
## 参与开发
请阅读 [CONTRIBUTING.md](CONTRIBUTING.md) 文件的相关内容。
## 版权
本项目源码采用 [MIT](https://opensource.org/licenses/MIT) 开源授权许可证，完整的授权说明可在 [LICENSE](LICENSE) 文件中找到。
文档内容的版权由各个文档各自表述。