通过beego快速创建一个Restful风格API项目及API文档自动化
2016-10-26 14:27
661 查看
通过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文档
五、集成Swagger UI,在线提供Restful风格的测试接口和数据
*Swagger UI是一款RESTFUL接口的文档在线自动生成+功能测试功能软件。官网http://swagger.io
5.1 手动下载swagger到项目目录
下载beego提供的swagger包(https://github.com/beego/swagger/releases)解压至项目目录或者到官方地址https://github.com/swagger-api/swagger-ui下载Swagger-UI,
把该项目dist目录下的内容拷贝到项目的swagger目录下,修改index.html中的默认的url为(http://127.0.0.1:8080/docs)
5.2 访问http://127.0.0.1:8080/swagger
六、代码示例
本示例代码存放在 https://github.com/huligong1234/go-study/tree/master/day06/jeedev-api
参考资料:
beego官方文档--API自动化文档 http://beego.me/docs/advantage/docs.mdbeego API开发以及自动化文档 http://my.oschina.net/astaxie/blog/284072
视频教程-beego 一分钟创建API http://www.tudou.com/programs/view/aM7iKLlBlrU/
相关文章推荐
- 通过beego快速创建一个Restful风格API项目及API文档自动化(转)
- 通过beego快速创建一个Restful风格API项目及API文档自动化
- 通过beego快速创建一个Restful风格API项目及API文档自动化 本文演示如何快速(一分钟内,不写一行代码)的根据数据库及表创建一个Restful风格的API项目,及提供便于在线测试API的界
- 快速搭建一个restful风格的springboot项目
- 通过Revit API创建一个族并载入到工程文档中
- webservice知识一、SOAP风格的webservice——通过JDK的API发布一个webservice服务和创建一个webservice客户端用于访问该服务
- 用python创建一个简单的restful风格的web服务应用
- 通过Jersey客户端API调用RestFul风格的Web服务
- Flex中如何通过strokeWidth, strokeColor和shadowColor样式,创建一个自定义风格的HRule或VRule
- 使用CXF+spring+restful创建一个web的接口项目
- 使用python创建一个简单的restful风格的webservice应用
- 关于Maven中的常见命令,通过命令的方式快速创建一个空的maven工程,将jar包打到maven仓库中
- jQuery 1.7 正式版已经可以下载使用。jQuery是一个JavaScript库,它简化了HTML文档遍历,事件处理,动画和为网络快速发展的Ajax交互。jQuery 1.7 版本加入了新的事件API .on() 和 .off(),提
- 为你的ActionScript项目创建API文档
- 如何快速学会在github 上创建一个项目
- 通过ASP.NET Web API + JQuery创建一个简单的Web应用
- exlipce mar 创建一个rest风格的webService项目(axis2)
- 通过ASP.NET Web API + JQuery创建一个简单的Web应用
- 采用CXF+spring+restful创建一个web接口项目
- (转)通过ASP.NET Web API + JQuery创建一个简单的Web应用