# apisix-plugin-template

**Repository Path**: mirrors_api7/apisix-plugin-template

## Basic Information

- **Project Name**: apisix-plugin-template
- **Description**: Simple template to get started with custom Apache APISIX plugins
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2022-01-21
- **Last Updated**: 2026-03-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# APISIX Plugin Template

[![Build Status](https://github.com/api7/apisix-plugin-template/actions/workflows/ci.yml/badge.svg)](https://github.com/api7/apisix-plugin-template/actions)

This template can be used to create custom Lua plugins for [Apache APISIX](https://github.com/apache/apisix).

# Table of Contents

- [APISIX Plugin Template](#apisix-plugin-template)
- [Table of Contents](#table-of-contents)
- [Usage](#usage)
- [Plugin Template Structure](#plugin-template-structure)
- [Testing](#testing)
- [Learn More](#learn-more)

# Usage

You can use this template by clicking the "[Use this template](https://github.com/api7/apisix-plugin-template/generate)" button on the top.

You can then clone the newly generated repository to your local machine and write your custom code.

[Back to TOC](#table-of-contents)

# Plugin Template Structure

The template contains the following files:

```shell
.
├── .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](#table-of-contents)

# Testing

To test your custom plugin, you can [write tests](https://apisix.apache.org/docs/apisix/internal/testing-framework) for it and run these tests in the CI.

The [ci.yml](.github/workflows/ci.yml) workflow runs the tests cases in the t folder on push and pull_request events.

[Back to TOC](#table-of-contents)

# Learn More

- [APISIX testing framework](https://apisix.apache.org/docs/apisix/internal/testing-framework)
- [Developing custom APISIX plugins](https://apisix.apache.org/docs/apisix/plugin-develop)
- [APISIX debug mode](https://apisix.apache.org/docs/apisix/architecture-design/debug-mode)
- [APISIX code style](https://github.com/apache/apisix/blob/master/CODE_STYLE.md)