转载

通过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环境

官方文档指南 http://beego.me/quickstart

三、通过数据库创建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文档

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

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

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

5.1 手动下载swagger到项目目录

下载beego提供的swagger包,
解压至项目目录
或者到官方地址下载Swagger-UI, 把该项目dist目录下的内容拷贝到项目的swagger目录下，修改index.html中的默认的url为 http://127.0.0.1:8080/docs

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

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

六、代码示例

本示例代码存放在 https://github.com/huligong1234/go-study/tree/master/day06/jeedev-api

参考资料：

beego官方文档--API自动化文档 http://beego.me/docs/advantage/docs.md
beego API开发以及自动化文档 http://my.oschina.net/astaxie/blog/284072
视频教程-beego 一分钟创建API http://www.tudou.com/programs/view/aM7iKLlBlrU/

正文到此结束

所属分类：编程技术

本文标签： git RESTful value mysql struct 数据 key 自动化 UI HTML db sql App tab 数据库 TCP 测试 tar 代码开发 root GitHub REST 目录 https API 软件
版权声明： 本文为互联网转载文章，出处已在文章中说明(部分除外)。如果侵权，请联系本站长删除，谢谢。
本文海报： 生成海报一生成海报二

其他链接

关于本站

本站定位：个人技术类博客

本站作用：写博客、记日志、闲聊扯淡鼓捣技术。

问题交流

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

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

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

二、创建golang及beego环境

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

四、API文档自动化

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

5.1 手动下载swagger到项目目录

六、代码示例

参考资料：

热门推荐

相关文章

说给你听

本文目录

随机标签

书籍教程

近期评论

网站信息

其他链接

关于本站

问题交流