membphis commented on a change in pull request #1055: doc: Add doc for fault-injection plugin. URL: https://github.com/apache/incubator-apisix/pull/1055#discussion_r366651736
########## File path: doc/plugins/fault-injection-cn.md ########## @@ -0,0 +1,149 @@ +<!-- +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +--> + +[English](fault-injection.md) + +# fault-injection + +故障注入插件，该插件可以和其他插件一起使用，并且会在其他插件前被执行，配置 `abort` 参数将直接返回给客户端指定的响应码并且终止其他插件的执行，配置 `delay` 参数将延迟某个请求，并且还会执行配置的其他插件。 + +### 参数 + +|名称 |必须|描述| +|------- |-----|------| +|abort|否|参数 http_status ：必须，返回给客户端的 http 状态码| +|||参数 body ：可选，返回给客户端的响应数据| +|delay|否|参数 duration ：必须，延迟时间，可以指定小数| + +注：参数 abort 和 delay 至少要存在一个 + +### 示例 + +#### 启用插件 + +示例1：为特定路由启用 `fault-injection` 插件，并指定 `abort` 参数： + +```shell +curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d ' +{ + "plugins": { + "fault-injection": { Review comment: Replace `tab` with spaces. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
