设为首页 加入收藏

TOP

通过beego快速创建一个Restful风格API项目及API文档自动化
2017-11-07 08:56:53 】 浏览:23
Tags:通过 beego 快速 创建 一个 Restful 风格 API 项目 文档 自动化

通过beego快速创建一个Restful风格API项目及API文档自动化

本文演示如何快速(一分钟内,不写一行代码)的根据数据库及表创建一个Restful风格的API项目,及提供便于在线测试API的界面。


一、创建数据库及数据表(MySQL)

#db--jeedev

-- ----------------------------
-- Table structure for `app`
-- ----------------------------
DROP TABLE IF EXISTS `app`;
CREATE TABLE `app` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `create_date` datetime NOT NULL,
  `app_code` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
  `app_name` varchar(255) COLLATE utf8_unicode_ci NOT NULL,
  `publish_date` date DEFAULT NULL,
  PRIMARY KEY (`id`),
  UNIQUE KEY `app_code` (`app_code`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;

-- ----------------------------
-- Records of app
-- ----------------------------
INSERT INTO `app` VALUES ('1', NOW(), '100000', '神庙逃亡', '2015-08-06');
INSERT INTO `app` VALUES ('2', NOW(), '100001', '愤怒的小鸟', '2015-08-06');

二、创建golang及beego环境

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

>>bee api jeedev-api -conn="root:123456@tcp(127.0.0.1:3306)/jeedev"

四、API文档自动化

>>cd ./jeedev-api
>>bee generate docs
>>bee run watchall true
//访问 <http://127.0.0.1:8080/docs> 即可看到自动化生产的API文档

文档自动化

五、集成Swagger UI,在线提供Restful风格的测试接口和数据

*Swagger UI是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。官网http://swagger.io

5.1 手动下载swagger到项目目录

5.2 访问http://127.0.0.1:8080/swagger

swagger ui

六、代码示例

参考资料:

】【打印繁体】【投稿】【收藏】 【推荐】【举报】【评论】 【关闭】 【返回顶部
上一篇Docker windows下安装并搭建Nodej.. 下一篇GO 1.5 代码编译安装 [centos7 64..

评论

帐  号: 密码: (新用户注册)
验 证 码:
表  情:
内  容:

最新文章

热门文章

C 语言

C++基础

windows编程基础

linux编程基础

C/C++面试题目