This documentation explains how to develop this project.
make setup
Installation dependenciesmake dev
to start it/path/to/apisix-python-plugin-runner/apisix/plugin
the .py
files in this directory autoload
/path/to/apisix-python-plugin-runner/apisix/plugin/say.py
from apisix.runner.plugin.base import Base from apisix.runner.http.request import Request from apisix.runner.http.response import Response class Test(Base): def __init__(self): super(Test, self).__init__(self.__class__.__name__) def filter(self, request: Request, response: Response): """ The plugin executes the main function :param request: request parameters and information :param response: response parameters and information :return: """ # Get plugin configuration information through `self.config` # print(self.config) # Set response headers headers = request.headers headers["X-Resp-A6-Runner"] = "Python" response.headers = headers # Set response body response.body = "Hello, Python Runner of APISIX" # Set response status code response.status_code = 201 # Set the plug-in to `stop` type, default `rewrite`, use `self.rewrite()` to declare it as `rewrite` type. self.stop()
Base
classfilter
functionfilter
function parameters can only contain Request
and Response
classes as parametersself.config
can get plug-in configuration informationself.stop()
to set the plugin as a stop
type plugin, which will interrupt the request.self.rewrite()
to set the plugin as a rewrite
type plugin, which will not interrupt the request.Run make test
.
1 byte of type + 3 bytes of length + data