This template can be used to create custom Lua plugins for Apache APISIX.
Extended from api7/apisix-plugin-template.
You can use this template by clicking the "Use this template" button on the top.
You can then clone the newly generated repository to your local machine and write your custom code.
The template contains the following files:
.
├── .github/ GitHub Actions workflows and Dependabot configuration files
├── apisix All files in this folder will be copied and will overwrite the original APISIX files
│ └── plugins/ Your custom plugin goes here
├── ci All files in this folder will be copied and will overwrite the original APISIX
│ └── utils/ CI utils script folder
├── examples/ APISIX examples
├── t/ Test cases
├── LICENSE
├── Makefile
└── README.md
To install custom plugins in APISIX there are 2 methods:
- placing them alongside other built-in plugins, in
${APISIX_INSTALL_DIRECTORY}/apisix/plugins/(by default/usr/local/apisix/apisix/plugins/); - placing them in a custom directory and setting
apisix.extra_lua_pathto point that directory, inconfig.yaml.
To test your custom plugin, you can:
- enable it on a route or a global rule and try sending a request;
- write tests for it and run these tests in a Docker container locally or in the CI.
TODO
The ci.yml workflow runs the tests cases in the t/ folder and can be triggered by a workflow_dispatch event, from GitHub: Actions | CI.
Folder examples/ contains a simple example that shows how to setup APISIX locally on Docker, and load the plugin(s).
For more examples, have a look at github.com/mikyll/apisix-examples.