在线时间:8:00-16:00
迪恩网络APP
随时随地掌握行业动态
扫描二维码
关注迪恩网络微信公众号
开源软件名称:apidoc开源软件地址:https://gitee.com/caixw/apidoc开源软件介绍:apidocapidoc 是一个简单的 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。 具体文档可参考:https://apidoc.tools /** * <api method="GET" summary="获取所有的用户信息"> * <path path="/users"> * <query name="page" type="number" default="0" summary="显示第几页的内容" /> * <query name="size" type="number" default="20" summary="每页显示的数量" /> * </path> * <tag>user</tag> * <server>users</server> * <response status="200" type="object" mimetype="application/json"> * <param name="count" type="int" optional="false" summary="符合条件的所有用户数量" /> * <param name="users" type="object" array="true" summary="用户列表"> * <param name="id" type="int" summary="唯一 ID" /> * <param name="name" type="string" summary="姓名" /> * </param> * <example mimetype="application/json"> * <![CDATA[ * { * "count": 500, * "users": [ * {"id":1, "name": "管理员2"}, * {"id":2, "name": "管理员2"} * ], * } * ]]> * </example> * </response> * <response status="500" mimetype="application/json" type="object"> * <param name="code" type="int" summary="错误代码" /> * <param name="msg" type="string" summary="错误内容" /> * </response> * </api> */func login(w http.ResponseWriter, r *http.Request) { // TODO} 使用在 https://github.com/caixw/apidoc/releases 提供了部分主流系统下的可用二进制。如果你使用的系统不在此列,则需要手动下载编译。 支持多种本地化语言,默认情况下会根据当前系统所使用的语言进行调整。也可以通过设置环境变更 LANG=lang apidoc # lang 设置为你需要的语言 ID,比如 zh-hans 等。 具体的安装和使用细节可参考 https://apidoc.tools/#usage。 集成若需要将 apidoc 当作包集成到其它 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...) 具体可查看文档:https://pkg.go.dev/github.com/caixw/apidoc/v7 参与开发请阅读 CONTRIBUTING.md 文件的相关内容。 版权本项目源码采用 MIT 开源授权许可证,完整的授权说明可在 LICENSE 文件中找到。 文档内容的版权由各个文档各自表述。 |
2023-10-27
2022-08-15
2022-08-17
2022-09-23
2022-08-13
请发表评论