api7 / apisix-plugin-template

Simple template to get started with custom Apache APISIX plugins

APISIX Plugin Template

This template can be used to create custom Lua plugins for Apache APISIX.

Table of Contents

• APISIX Plugin Template
• Table of Contents
• Usage
• Plugin Template Structure
• Testing
• Learn More

Usage

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.

Back to TOC

Plugin Template Structure

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
├── t/               Test cases go here
├── LICENSE
├── Makefile
└── README.md

Back to TOC

Testing

To test your custom plugin, you can write tests for it and run these tests in the CI.

The ci.yml workflow runs the tests cases in the t folder on push and pull_request events.

Back to TOC

Learn More

• APISIX testing framework
• Developing custom APISIX plugins
• APISIX debug mode
• APISIX code style