量个网站一个域名,c9设计软件,门户wordpress主题,手机建立网站该插件移植自 Python 的 Flask-Docs#xff0c;可以根据代码注释生成文档页面#xff0c;支持离线文档下载和生成#xff0c;支持在线调试#xff0c;支持密码认证。 Gin-Docs Gin API 文档自动生成插件 特性 根据代码注释自动生成 Markdown 文档支持离线 Markdown 文档下…该插件移植自 Python 的 Flask-Docs可以根据代码注释生成文档页面支持离线文档下载和生成支持在线调试支持密码认证。 Gin-Docs Gin API 文档自动生成插件 特性 根据代码注释自动生成 Markdown 文档支持离线 Markdown 文档下载支持在线调试支持生成离线文档 HTML Markdown 链接 https://github.com/kwkwc/gin-docs 安装 go get -u github.com/kwkwc/gin-docs 使用 import (github.com/gin-gonic/gingd github.com/kwkwc/gin-docs )r : gin.Default() r.POST(/api/todo, AddTodo) r.GET(/api/todo, GetTodo)c : gd.Config{} apiDoc : gd.ApiDoc{Ge: r, Conf: c.Default()} apiDoc.OnlineHtml()r.Run()查看文档页面 http://127.0.0.1/docs/api/演示 在线演示 配置 type Config struct {// 标题, default API DocTitle string// 版本, default 1.0.0Version string// 描述Description string// 自定义 CDN CSS 模板CdnCssTemplate string// 自定义 CDN JS 模板CdnJsTemplate string// 自定义 url prefix, default /docs/apiUrlPrefix string// 文档不存在时的描述, default No documentation found for this APINoDocText string// 启用文档页面, default trueEnable bool// 使用 CDN, default falseCdn bool// 需要排除的 API 包名Exclude []string// 允许显示的方法, default []string{GET, POST, PUT, DELETE, PATCH}MethodsList []string// SHA256 加密的授权密码例如这里是 admin// echo -n admin | shasum -a 256// 8c6976e5b5410415bde908bd4dee15dfb167a9c873fc4bb8a81f6f2ab448a918PasswordSha2 string// 启用 markdown 处理所有文档, default trueAllMd bool }标记 # 默认以 markdown 处理所有文档 # 1. 如果希望指定处理请使用 包裹 # 2. 如果希望展示原始文档请关闭 Config.AllMd并去除 标记 # 在这里写下你的 markdown 文档API /* Add todo### args | args | required | location | type | help | |-------|----------|----------|--------|----------| | name | true | json | string | todo name | | type | true | json | string | todo type |### request json {name: xx, type: code} ### response json {code: xxxx, msg: xxx, data: null}*/ func AddTodo(c *gin.Context) {c.JSON(http.StatusOK, gin.H{todo: post todo,}) }/* Get todo### descriptionGet todo### args | args | required | location | type | help | |-------|----------|----------|--------|----------| | name | true | query | string | todo name | | type | false | query | string | todo type |### requesthttp://127.0.0.1:8080/api/todo?namexxxtypecode ### response json {code: xxxx, msg: xxx, data: null}*/ func GetTodo(c *gin.Context) {c.JSON(http.StatusOK, gin.H{todo: get todo,}) }调试器 认证 生成离线文档 r : gin.Default()c : gd.Config{} apiDoc : gd.ApiDoc{Ge: r, Conf: c.Default()}// HTML: 在 htmldoc/ 生成离线 HTML 文档 out : htmldoc apiDoc.OfflineHtml(out, true)r.StaticFile(c.UrlPrefix/, filepath.Join(out, index.html)) r.StaticFile(c.UrlPrefix/data, filepath.Join(out, data)) r.Static(c.UrlPrefix/static, filepath.Join(out, static))// Markdown: 生成 doc.md 离线 Markdown 文档 apiDoc.OfflineMarkdown(doc.md, true)示例 Complete example 开发 # 克隆代码 git clone gitgithub.com:kwkwc/gin-docs.git# 工作目录 cd gin-docs# 安装依赖 make install# 运行检查 make check-all移植项目 Flask-Docs