博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
beego 实现API自动化文档
阅读量:5861 次
发布时间:2019-06-19

本文共 1793 字,大约阅读时间需要 5 分钟。

安装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,可以通过手动方式下载,地址:,解压至项目目录。

或者到 下载zip包,解压后把dist文件夹复制到swagger目录下即可访问里面的index.html,把index.html 的url改成本地的。

4、路由代码和注释参考官网:

 

转载地址:http://hxrjx.baihongyu.com/

你可能感兴趣的文章
非常实用的Windows7进阶功能
查看>>
监控软件zabbix之安装
查看>>
Python [4] Django的安装和基础运行环境简介
查看>>
关于l ibrary not found for -lz.1.2.3 编译错误
查看>>
No architectures to compile for (ONLY_ACTIVE_ARCH=YES, active arch=arm64, VALID_ARCHS=armv7 armv7s)
查看>>
部署WSUS2.0+SP1
查看>>
GAE开发注意事项总结
查看>>
Codeforces Round #326 (Div. 2) B. Pasha and Phone C. Duff and Weight Lifting
查看>>
zabbix 监控主机tcp连接数
查看>>
【Hibernate框架开发之二】采用@Entity、@Id直接映射实体类
查看>>
从server 2003域控制器升级到server 2008
查看>>
活动目录系列之三:多域环境的实现(单站点)
查看>>
问题步骤记录器——“懒教师”的好帮手
查看>>
【网络基础】《TCP/IP详解》学习笔记7
查看>>
Spring(13)——PropertyPlaceholderConfigurer(二)之namespace
查看>>
杂七杂八——使用LINQ检索重复值
查看>>
【我们都爱Paul Hegarty】斯坦福IOS8公开课个人笔记36 TableViewDatasource
查看>>
HTTP Referer
查看>>
解析思科IOS操作顺序-----包被如何处理-----不是我解析的 哈哈
查看>>
Android自定义摇杆
查看>>