https://github.com/Kong/kong/tree/master/kong/plugins/request-termination

handler.lua

  1. local kong = kong
  4. local DEFAULT_RESPONSE = {
  5.   [401] = "Unauthorized",
  6.   [404] = "Not found",
  7.   [405] = "Method not allowed",
  8.   [500] = "An unexpected error occurred",
  9.   [502] = "Bad Gateway",
  10.   [503] = "Service unavailable",
  11. }
  14. local RequestTerminationHandler = {}
  17. RequestTerminationHandler.PRIORITY = 2
  18. RequestTerminationHandler.VERSION = "2.0.1"
  21. function RequestTerminationHandler:access(conf)
  22.   local status  = conf.status_code
  23.   local content = conf.body
  25.   if content then
  26.     local headers = {
  27.       ["Content-Type"] = conf.content_type
  28.     }
  30.     return kong.response.exit(status, content, headers)
  31.   end
  33.   local message = conf.message or DEFAULT_RESPONSE[status]
  34.   return kong.response.exit(status, message and { message = message } or nil)
  35. end
  38. return RequestTerminationHandler

schema.lua

  1. local typedefs = require "kong.db.schema.typedefs"
  4. local is_present = function(v)
  5.   return type(v) == "string" and #v > 0
  6. end
  9. return {
  10.   name = "request-termination",
  11.   fields = {
  12.     { protocols = typedefs.protocols_http },
  13.     { config = {
  14.         type = "record",
  15.         fields = {
  16.           { status_code = {
  17.             type = "integer",
  18.             default = 503,
  19.             between = { 100, 599 },
  20.           }, },
  21.           { message = { type = "string" }, },
  22.           { content_type = { type = "string" }, },
  23.           { body = { type = "string" }, },
  24.         },
  25.         custom_validator = function(config)
  26.           if is_present(config.message)
  27.           and(is_present(config.content_type)
  28.               or is_present(config.body)) then
  29.             return nil, "message cannot be used with content_type or body"
  30.           end
  31.           if is_present(config.content_type)
  32.           and not is_present(config.body) then
  33.             return nil, "content_type requires a body"
  34.           end
  35.           return true
  36.         end,
  37.       },
  38.     },
  39.   },
  40. }
参数 默认值 描述
name 要使用的插件的名称，在本例中为ip-restriction
service_id 此插件将定位的 Service 的ID。
route_id 此插件将定位的 Route 的ID。
enabled true 是否将应用此插件。
consumer_id 此插件将定位的Consumer的id
config.status_code
optional		 要发送的响应代码。
config.message
optional		 要使用默认响应生成器发送的消息。
config.body
optional		 要发送的原始响应body，这与config.message字段互斥。
config.content_type
optional		 application/json; charset=utf-8 使用config.body配置的原始响应的Content type。

使用后，将通过发送配置的响应立即终止每个请求（在 Service, Route, Consumer, 或全局的已配置插件范围内）。

使用示例

  • 暂时禁用 Service（例如，它正在维护中）。
  • 暂时禁用 Route（例如，服务的其余部分已启动并正在运行，但必须禁用特定端点）。
  • 暂时禁用 Consumer（例如过度消费）。
  • 在逻辑OR设置中使用多个auth插件阻止匿名访问。