Skip to main content
Version: 0.1.0

Developer Guide


This documentation explains how to develop this project.


  • Python 3.6+
  • APISIX 2.7.0


  • Run make setup Installation dependencies
  • Run make dev to start it


Plugin directory#


the .py files in this directory autoload

Plugin example#


Plugin Format#

from apisix.runner.plugin.base import Basefrom apisix.runner.http.request import Requestfrom 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()
  • The plugin must inherit the Base class
  • The plugin must implement the filter function
  • filter function parameters can only contain Request and Response classes as parameters
  • Request parameter can get request information
  • Response parameter can set response information
  • self.config can get plug-in configuration information
  • Use self.stop() to set the plugin as a stop type plugin, which will interrupt the request.
  • Use self.rewrite() to set the plugin as a rewrite type plugin, which will not interrupt the request.


Run make test.

Data Format#


Data Protocol#

1 byte of type + 3 bytes of length + data