本文作者：HelloGitHub-嘉文
這里是 HelloGitHub 推出的《講解開源項目》系列，今天給大家帶來一款開源免費的模擬后端 API 的工具：moco
沒學過后端開發的也能快速上手這個開源項目，靚仔靚妹們不必再辛苦等待后端開發 API，從而有更多的時間逛 HelloGitHub 體驗更多有趣的開源項目。接下來本文將用帶你快速上手 moco 這個開源工具，讓你不再卡在后端接口的開發進度上，一騎絕塵！
一、moco 有什么用
我做前端或者客戶端開發，對我有什么用？
- 在后端 API 開發緩慢的時候，如果你想測試應用展示效果，就不必再等后端進度，使用 moco 輕松模擬后端 API。
- 在項目初期的時候，產品經理或者是客戶想看到你的應用展示，模擬好 API 就可以開發前端，展示效果啦。
我做后端開發，對我有什么用？
- 企業級軟件一般都是多人開發，因為接口之間是互相依賴的，所以如果你依賴的服務進度緩慢或者是沒有在環境中運行，你就無法對你開發的功能進行測試，進而不能及時交付項目，從而加班熬夜。
- 即使你所依賴的服務在環境中運行，但是所依賴的服務依舊會不斷測試和調優，這個過程也可能會導致你開發功能測試出現問題。一個穩定的測試接口，減少你的等待時間。
二、快速開始
2.1 准備工作
JDK 1.8+ (推薦1.8版本)
2.2 下載 jar 包
2.3 API 配置文件
新建 hello.json 文件，寫入以下內容
[{
"description": "moco 快速開始示例",
"request": {
"uri": "/hello"
},
"response": {
"text": "Hello GitHub"
}
}]
目錄結構如下
├── hello.json // API 接口配置文件
├── moco-runner-1.1.0-standalone.jar // 下載的模擬 API 的工具
2.4 運行項目
在該目錄下運行
java -jar moco-runner-1.1.0-standalone.jar http -p 9999 -c hello.json
moco-runner-1.1.0-standalone.jar：運行程序的路徑（剛剛下載的包的路徑）
http：選擇服務類型（有 http、https、socket）
-p 9999：設置服務端口 9999
-c hello.json：設置配置文件路徑（剛剛新建的配置文件）
2.5 效果展示
在瀏覽器中訪問一下地址
localhost:9999/hello
效果如圖所示
三、詳細用法
剛剛的你應該十分輕松地模擬一個簡單的后端 API，是不是很有成就感？但是你使用或者開發過后端 API 你就也許知道：一個合格的后端 API 不應該僅僅局限如此。一個合格的后端 API 應該能包括：請求方法、請求 URL、請求參數、請求頭、請求體、返回狀態碼、返回提示信息、返回頭和返回體等內容。
如何使用 moco 這個開源項目模擬出一個合格的后端接口呢？接下來就帶你一步步了解詳細用法。
3.1 基本結構
[
{
"description": "moco 基本結構",
"request": {
"uri": "/hello",
"method": "post"
},
"response": {
"text": "Hello GitHub"
}
}
]
- json 文件的最層是一個
[]數組，里面可以封裝多個 API（示例只有一個 API） - 因為 json 配置文件不支持注釋，所以這個 API 的注釋你可以寫到
description里面 request可以包含請求的所有內容response可以包含返回的所有內容
3.2 模擬一個基本的 RESTful API
[{
"description": "模擬一個基本的 RESTful API",
"request": {
"uri": "/hello2",
"method": "post",
"headers": {
"Content-Type": "application/json",
"Accept": "application/json",
"token": "header.playload.signature",
"Accept-Charset": "utf8"
},
"cookies": {
"login": "true"
},
"json": {
"name": "zhangsan",
"age": 13
}
},
"response": {
"json": {
"message": "測試成功"
},
"latency": {
"duration": 2,
"unit": "second"
},
"headers": {
"Content-Type": "application/json",
"token": "new-header.new-playload.new-signature"
},
"cookies": {
"login": {
"value": "true",
"domain": "localhost",
"secure": "true",
"httpOnly": "true",
"path": "/"
}
}
}
}]
method：請求方法headers：請求頭cookies：請求 Cookiesjson：請求體的一種類型（還有froms表單等類型）response返回值的headers、json、cookies也類似latency模擬服務器卡頓（因為模擬的后端 API 返回數據幾乎是瞬間的，這里我們讓其卡頓 2 秒）
測試
這里我們使用 GitHub 上面開源免費的 API 測試軟件 Postman 進行測試
（1）url、請求方法、請求頭和 Cookies
（2）請求體（json）
（3）測試效果
點擊 Send 發送，並在下方 response 查看測試效果
查看返回的請求頭
查看返回的 Cookies
查看全局 Cookies
3.3 附件下載
有時候我們需要模擬文件下載，moco 如何實現呢？
[{
"description": "moco 附件下載",
"request": {
"uri": "/hello"
},
"response": {
"attachment":{
"filename": "demo.txt",
"file": "demo.txt"
}
}
}]
文件目錄
├── hello.json // API 接口配置文件
├── moco-runner-1.1.0-standalone.jar // 模擬 API 的工具
├── demo.txt // 要下載的文件，這里可以使用相對路徑
localhost:9999/hello 即可下載 demo.txt 文件
3.4 輪詢數據
如果我們刷新頁面想獲得不同的內容 moco 如何實現呢？
[{
"description": "moco 輪詢數據",
"request": {
"uri": "/hello"
},
"response": {
"cycle": [{
"text": "hello 1"
},
{
"text": "hello 2"
},
{
"text": "hello 3"
}
]
}
}]
訪問 localhost:9999/hello 會依次得到如下內容
hello 1
hello 2
hello 3
hello 1
hello 2
...
3.5 重定向
有時候我們想重定向頁面 moco 如何實現呢？
[{
"description": "moco 重定向",
"request": {
"uri": "/hello"
},
"redirectTo": "https://hellogithub.com"
}]
訪問 localhost:9999/hello 會自動重定向到 https://hellogithub.com
3.6 正則表達式
moco 還支持一些運算符，比如正則表達式。
[{
"description": "moco 正則表達式",
"request": {
"uri": {
"match": "/hello/\\w*"
}
},
"response": {
"text": "Hello GitHub"
}
}]
可以通過正則表達式匹配的鏈接訪問，比如
localhost:9999/hello/jarvan
localhost:9999/hello/bmft
3.7 使用模板
有的時候我們的返回參數依賴於請求參數（比如編碼類型），這個時候我們就可以用 template 模板來實現，我們可以在模板中通過 req 來表示發送的請求 。
{
"description": "moco 使用模板",
"request": {
"uri": "/hello",
"method": "post"
},
"response": {
"text": {
"template": "${req.method}"
}
}
}
返回的值是
{
"text": "post"
}
四、最后
看到這里，想必你已經了解開源項目 moco 的基本使用了，是不是覺得很有意思？這里給出一個小建議，如果想真正使用這個開源項目 moco，建議參考官方文檔去「實踐」，這是最快捷，最有效的使用開源項目的辦法。「實踐」就是鞏固的最佳方法，希望你能在實踐中體驗設計程序的快樂！
至此，感謝熱愛開源的小伙伴們的閱讀。**公眾號 HelloGitHub ** 會定時介紹 GitHub 上有趣的開源免費的項目，如果你對開源項目感興趣，那就關注我們收到第一時間的文章推送吧。
參考: