beego 实现API自动化文档

时间：2021-01-29 00:35:16

安装beego和bee工具

1、beego安装

go get -u github.com/astaxie/beego

2、安装bee工具

go get -u github.com/beego/bee

创建已设计的库

-- ----------------------------

-- Table structure for evops_heartbeat

-- ----------------------------

DROP TABLE IF EXISTS `evops_heartbeat`;

CREATE TABLE `evops_heartbeat` (

  `id` bigint(20) NOT NULL AUTO_INCREMENT,

  `hostname` varchar(40) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '',

  `client_ip` varchar(50) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '',

  `proxy_ip` varchar(50) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '',

  `version` varchar(10) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '',

  `build_time` varchar(30) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '',

  `os` varchar(20) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '',

  `user` varchar(40) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '',

  `hbs_status` varchar(10) COLLATE utf8mb4_unicode_ci NOT NULL DEFAULT '',

  `pub_status` int(11) NOT NULL DEFAULT '0',

  `timestamp` datetime NOT NULL,

  PRIMARY KEY (`id`),

  UNIQUE KEY `client_ip` (`client_ip`),

  KEY `evops_heartbeat_timestamp` (`timestamp`)

) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_ci;

-- ----------------------------

-- Records of evops_heartbeat

-- ----------------------------

INSERT INTO `evops_heartbeat` VALUES ('1', 'localhost.localdomain', '192.168.1.93', '192.168.1.93', 'v1.3', '2018-07-03 14:24:03', 'Linux', 'root', 'true', '0', '2018-07-03 15:16:05');

通过数据库创建Restful风格API项目

bee api EvopsProxy -conn="root:123456@tcp(192.168.1.93:3306)/agentmanage"

API文档自动化

1、进入EvopsProxy目录

2、启动命令

bee run -gendoc=true -downdoc=true

-gendoc=true 表示每次自动化的build文档，-downdoc=true 就会自动的下载swagger文档查看器

3、如果无法自动下载swagger，可以通过手动方式下载，地址：https://github.com/beego/swagger/releases，解压至项目目录。

或者到 https://github.com/swagger-api/swagger-ui下载zip包，解压后把dist文件夹复制到swagger目录下即可访问里面的index.html，把index.html 的url改成本地的。

4、路由代码和注释参考官网：https://beego.me/docs/advantage/docs.md

beego 实现API自动化文档

相关文章