在專案開發過程中,往往是多個合作方一同開發,多個合作方相互依賴,而這種依賴在專案過程中會造成相互制約,理解誤差也會影響開發進度,甚至影響專案的工期。所以在開發過程中,一般都會使用 Mock 來類比最初預定的返回結果,來降低理解偏差,從而提升開發效率。API Gateway也支援 Mock 模式的簡單配置。
配置 Mock
在 API 編輯頁面--定義API後端服務,來配置 Mock。
1. 填寫 Mock 返回結果
Mock 返回結果,可以填寫您真實的返回結果。目前支援是 Json、XMl、文本等格式作為 Mock 返回結果。如:
{
"result": {
"title": " API Gateway Mock 測試",
...
}
}
儲存後 Mock 設定成功,請根據實際需要 發布 到測試或線上環境進行測試,也可以在 API 調試頁面進行調試。
Mock Body大小限制為50KB。
2. 填寫 Mock 請求響應statusCode
支援的statusCode取值如下表,相容HTTP 1.1 Response Status Code的格式返回及其狀態,如果您定義的statusCode不在下表中,將提示參數無效:
http code | http message |
200 | OK |
201 | Created |
202 | Accepted |
203 | Non-Authoritative Information |
204 | No Content |
205 | Reset Content |
206 | Partial Content |
300 | Multiple Choices |
301 | Moved Permanently |
302 | Found |
303 | See Other |
304 | Not Modified |
305 | Use Proxy |
306 | (Unused) |
307 | Temporary Redirect |
400 | Bad Request |
401 | Unauthorized |
402 | Payment Required |
403 | Forbidden |
404 | Not Found |
405 | Method Not Allowed |
406 | Not Acceptable |
407 | Proxy Authentication Required |
408 | Request Timeout |
409 | Conflict |
410 | Gone |
411 | Length Required |
412 | Precondition Failed |
413 | Request Entity Too Large |
414 | Request-URI Too Long |
415 | Unsupported Media Type |
416 | Requested Range Not Satisfiable |
417 | Expectation Failed |
450 | Parameter Requried |
451 | Method Connect Exception |
500 | Internal Server Error |
501 | Not Implemented |
502 | Bad Gateway |
503 | Service Unavailable |
504 | Gateway Timeout |
505 | HTTP Version Not Supported |
3. 定義Mock Header
API Gateway支援自訂Mock Header,允許Header同名,Header定義後取值不可為空,設定Mock時,Header Name不允許為空白,並且只能由數字、字母、底線、減號組成。Header Value不允許為空白。
解除 Mock
若您需要解除 Mock,選擇其他後端服務類型即可,而 Mock 返回結果中的值不會被清除,以便您進行下一次的 Mock。修改完成後請發布,只有發布後才會真正生效。