通過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:[email protected](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.md
• beego API開發以及自動化文檔 http://my.oschina.net/astaxie/blog/284072
• 視頻教程-beego 一分鐘創建API http://www.tudou.com/programs/view/aM7iKLlBlrU/

通過beego快速創建一個Restful風格API項目及API文檔自動化(轉)