在项目开发过程中,往往是多个合作方一同开发,多个合作方相互依赖,而这种依赖在项目过程中会造成相互制约,理解误差也会影响开发进度,甚至影响项目的工期。所以在开发过程中,一般都会使用 Mock 来模拟最初预定的返回结果,来降低理解偏差,从而提升开发效率。API 网关也支持 Mock 模式的简单配置。
配置 Mock
在 API 编辑页面--定义API后端服务,来配置 Mock。
1. 填写 Mock 返回结果
Mock 返回结果,可以填写您真实的返回结果。目前支持是 Json、XMl、文本等格式作为 Mock 返回结果。如:
{
"result": {
"title": " API 网关 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网关支持自定义Mock Header,允许Header同名,Header定义后取值不能为空,设置Mock时,Header Name不允许为空,并且只能由数字、字母、下划线、减号组成。Header Value不允许为空。
解除 Mock
若您需要解除 Mock,选择其他后端服务类型即可,而 Mock 返回结果中的值不会被清除,以便您进行下一次的 Mock。修改完成后请发布,只有发布后才会真正生效。