RESTful API 文档生成工具 apidoc

xnotepad · · 162 次点击 · 开始浏览    置顶
apidoc 是一个简单的 RESTful API 文档生成工具,它从代码注释中提取特定格式的内容,生成文档。 目前支持支持以下语言:C#、C/C++、D、Dart、Erlang、Go、Groovy、Java、JavaScript、Kotlin、Lisp/Clojure、Lua、Pascal/Delphi、Perl、PHP、Python、Ruby、Rust、Scala、Swift、Typescript 和 Zig。 官网:<https://apidoc.tools> ```go /** * <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> 可下载各个系统下已编译好的程序

有疑问加站长微信联系

入群交流(和以上内容无关):加入Go大咖交流群,或添加微信:liuxiaoyan-s 备注:入群;或加QQ群:812540095

162 次点击  
加入收藏 微博
暂无回复
添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
  • 图片支持拖拽、截图粘贴等方式上传