{"id":26182589,"url":"https://github.com/mikyll/apisix-plugin-template","last_synced_at":"2026-04-29T21:34:58.959Z","repository":{"id":281901475,"uuid":"940816667","full_name":"mikyll/apisix-plugin-template","owner":"mikyll","description":"Simple template to get started with custom Apache APISIX plugins","archived":false,"fork":false,"pushed_at":"2025-11-21T13:15:41.000Z","size":69,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-13T04:39:01.327Z","etag":null,"topics":["apache-apisix","apisix","apisix-plugin","custom-plugin","lua","nginx","openresty"],"latest_commit_sha":null,"homepage":"","language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mikyll.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-02-28T21:08:08.000Z","updated_at":"2025-08-11T20:42:32.000Z","dependencies_parsed_at":null,"dependency_job_id":"3ab2b882-cba5-4378-a9e3-1c9d75e14d76","html_url":"https://github.com/mikyll/apisix-plugin-template","commit_stats":null,"previous_names":["mikyll/apisix-plugin-template"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/mikyll/apisix-plugin-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikyll%2Fapisix-plugin-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikyll%2Fapisix-plugin-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikyll%2Fapisix-plugin-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikyll%2Fapisix-plugin-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mikyll","download_url":"https://codeload.github.com/mikyll/apisix-plugin-template/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikyll%2Fapisix-plugin-template/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32445503,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T20:22:27.477Z","status":"ssl_error","status_checked_at":"2026-04-29T20:22:26.507Z","response_time":110,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apache-apisix","apisix","apisix-plugin","custom-plugin","lua","nginx","openresty"],"created_at":"2025-03-11T22:23:01.065Z","updated_at":"2026-04-29T21:34:58.952Z","avatar_url":"https://github.com/mikyll.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n[![APISIX][apisix-shield]][apisix-url]\n[![NGINX][nginx-shield]][nginx-url]\n[![Lua][lua-shield]][lua-url]\n[![Perl][perl-shield]][perl-url]\n[![YAML][yaml-shield]][yaml-url]\\\n[![Build Status][build-status-shield]][build-status-url]\n\n# APISIX Plugin Template\n\nThis template can be used to create custom Lua plugins for [Apache APISIX](https://github.com/apache/apisix).\u003cbr\u003e\nExtended from [api7/apisix-plugin-template](https://github.com/api7/apisix-plugin-template).\n\n\u003c/div\u003e\n\n## Table of Contents\n\n- [APISIX Plugin Template](#apisix-plugin-template)\n  - [Table of Contents](#table-of-contents)\n  - [Template Usage](#template-usage)\n  - [Plugin Template Structure](#plugin-template-structure)\n  - [Plugin Usage](#plugin-usage)\n    - [Installation](#installation)\n  - [Testing](#testing)\n    - [Local Docker](#local-docker)\n    - [CI](#ci)\n  - [Examples](#examples)\n  - [Learn More](#learn-more)\n\n## Template Usage\n\nYou can use this template by clicking the \"[Use this template](https://github.com/api7/apisix-plugin-template/generate)\" button on the top.\n\nYou can then clone the newly generated repository to your local machine and write your custom code.\n\n[Back to TOC](#table-of-contents)\n\n## Plugin Template Structure\n\nThe template contains the following files:\n\n```lang-none\n.\n├── .github/         GitHub Actions workflows and Dependabot configuration files\n├── apisix           All files in this folder will be copied and will overwrite the original APISIX files\n│   └── plugins/     Your custom plugin goes here\n├── ci               All files in this folder will be copied and will overwrite the original APISIX\n│   └── utils/       CI utils script folder\n├── examples/        APISIX examples\n├── t/               Test cases\n├── LICENSE\n├── Makefile\n└── README.md\n```\n\n[Back to TOC](#table-of-contents)\n\n## Plugin Usage\n\n### Installation\n\nTo install custom plugins in APISIX there are 2 methods:\n\n- placing them alongside other built-in plugins, in `${APISIX_INSTALL_DIRECTORY}/apisix/plugins/` (by default `/usr/local/apisix/apisix/plugins/`);\n- placing them in a custom directory and setting `apisix.extra_lua_path` to point that directory, in `config.yaml`.\n\n[Back to TOC](#table-of-contents)\n\n## Testing\n\nTo test your custom plugin, you can:\n\n- enable it on a route or a global rule and try sending a request;\n- [write tests](https://apisix.apache.org/docs/apisix/internal/testing-framework) for it and run these tests in a Docker container locally or in the CI.\n\n### Local Docker\n\nTODO\n\n\u003c!--\nThis repository contains a [Docker image](examples/apisix-docker-custom/Dockerfile) which builds APISIX from source and installs the NGiNX testing framework. This can be used to run tests locally.\n--\u003e\n\n### CI\n\nThe [`ci.yml`](.github/workflows/ci.yml) workflow runs the tests cases in the [`t/`](t/) folder and can be triggered by a **workflow_dispatch** event, from GitHub: [Actions | CI](https://github.com/mikyll/apisix-plugin-template/actions/workflows/ci.yml).\n\n[Back to TOC](#table-of-contents)\n\n## Examples\n\nFolder [`examples/`](examples/) contains a simple example that shows how to setup APISIX locally on Docker, and load the plugin(s).\n\nFor more examples, have a look at [github.com/mikyll/apisix-examples](https://github.com/mikyll/apisix-examples).\n\n[Back to TOC](#table-of-contents)\n\n## Learn More\n\n- [APISIX Source Code](https://github.com/apache/apisix)\n- [APISIX Deployment Modes](https://apisix.apache.org/docs/apisix/deployment-modes/)\n- [Developing custom APISIX plugins](https://apisix.apache.org/docs/apisix/plugin-develop)\n- [APISIX testing framework](https://apisix.apache.org/docs/apisix/internal/testing-framework)\n- [APISIX debug mode](https://apisix.apache.org/docs/apisix/debug-mode/)\n- [NGiNX variables](https://nginx.org/en/docs/http/ngx_http_core_module.html#variables)\n- [APISIX Examples](https://github.com/mikyll/apisix-examples)\n\n\u003c!-- GitHub Shields --\u003e\n\n[apisix-shield]: https://custom-icon-badges.demolab.com/badge/APISIX-grey.svg?logo=apisix_logo\n[apisix-url]: https://apisix.apache.org/\n[nginx-shield]: https://img.shields.io/badge/Nginx-%23009639.svg?logo=nginx\n[nginx-url]: https://nginx.org/en/\n[lua-shield]: https://img.shields.io/badge/Lua-%232C2D72.svg?logo=lua\u0026logoColor=white\n[lua-url]: https://www.lua.org/\n[perl-shield]: https://img.shields.io/badge/Perl-%2339457E.svg?logo=perl\u0026logoColor=white\n[perl-url]: https://www.perl.org/\n[yaml-shield]: https://img.shields.io/badge/YAML-%23ffffff.svg?logo=yaml\u0026logoColor=151515\n[yaml-url]: https://yaml.org/\n[build-status-shield]: https://github.com/mikyll/apisix-plugin-template/actions/workflows/ci.yml/badge.svg\n[build-status-url]: https://github.com/mikyll/apisix-plugin-template/actions\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikyll%2Fapisix-plugin-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikyll%2Fapisix-plugin-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikyll%2Fapisix-plugin-template/lists"}