背景信息
当前用户在 Apache APISIX 中开发自定义插件时,可以为插件定义一些 API(下称 public API),比如在当前的 jwt-auth
插件中,它实现并提供了一个/apisix/plugin/jwt/sign
接口用于签发 JWT,由于此接口不是通过 Admin API 添加的,因此无法像管理 Route 一样管理此类接口。
在实际应用场景中,提供的接口是面向内部调用的,而非开放在公网供任何人调用。为了应对这种场景,Apache APISIX 设计了 plugin-interceptors
(插件拦截器),通过此功能可以让 public API 应用部分插件并实现请求过滤,但是当前仅支持 ip-restriction
插件。
由上可以看出,Apache APISIX 对于 public API 的请求过滤能力是比较弱的,所以不能使用 Apache APISIX 中其他插件实现复杂的认证和授权能力。
因此,Apache APISIX 设计了 public-api
插件,它替换了功能有限且使用复杂的插件拦截器。通过这个插件,可以解决 public API 使用过程中的痛点,您可以为 public API 设置自定义的 uri,可以配置任何类型的插件。下图展示了使用 public-api
前后的变化。
不支持在 Docs 外粘贴 block
初识 public-api
本节以 jwt-auth
插件的 /apisix/plugin/jwt/sign
接口为例,为您介绍两种 public-api
插件的使用方法和一种场景示例。
在使用 public-api
插件之前,如果在插件开发中使用 _M.api()
注册了 public API 后,APISIX 会默认将它暴露出来,您可以直接在 HTTP 端口调用这个 API。现在,您需要手动创建一个路由,配置 public-api
插件,才可以将 API 转发至 public-api
插件中。
确认 API 是否被开放
您可以通过下述命令请求 API 路径,通过返回结果可以看到 /apisix/plugin/jwt/sign
默认情况下并没有被暴露出来,是不可用的。
curl -XGET 'http://127.0.0.1:9080/apisix/plugin/jwt/sign?key=user-key'
{"error_msg":"404 Route Not Found"}
前提条件
您需要创建 Consumer 并开启 jwt-auth
插件,才可以使用 jwt-auth
插件。
示例中
jwt-auth
参数配置信息,请参考