openresty / openresty/test-nginx
Proposal: list Apache APISIX as a project using Test::Nginx
Nobody has claimed this yet.
- Dominant language
- Perl
- Stars
- 456
- Forks
- 112
- PR merge metrics
- No merged PRs in 30d
Description
Context
The README describes Test::Nginx as a test scaffold for NGINX C modules and NGINX/OpenResty-based libraries and applications. Its only project-usage list, however, covers NGINX C modules.
Apache APISIX is an API gateway built on OpenResty, and its public test suite uses Test::Nginx. The APISIX 3.17 testing guide documents how the suite prepares gateway configuration and mock upstreams, sends HTTP and stream requests, and checks status codes, response data, and logs. Its Makefile runs the suite with prove and the test-nginx library path.
Evidence:
- APISIX 3.17 architecture evidence: https://github.com/apache/apisix/blob/3.17.0/docs/en/latest/security-threat-model.md#L76-L77
- APISIX 3.17 testing guide: https://apisix.apache.org/docs/apisix/3.17/internal/testing-framework/
- APISIX 3.17.0
Makefile: https://github.com/apache/apisix/blob/3.17.0/Makefile#L420-L425
Proposed documentation change
Would the project accept a short, neutral Apache APISIX usage entry in the Test::Nginx documentation?
If so, I would prepare a documentation-only pull request that:
- adds APISIX under a separate application section, or in another location the maintainers prefer;
- links only to the APISIX source repository and versioned testing guide;
- updates the POD source, README, or both according to the repository's expected maintenance pattern; and
- makes no changes to Test::Nginx behavior, dependencies, or defaults.
The entry would document existing use rather than imply endorsement or describe APISIX product features. If application entries are outside this repository's scope, I will not proceed with a pull request.
Would this addition be useful? If so, which location and source files should a pull request update?
Yilia Lin, Apache APISIX Committer
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the README's current project-usage list and the APISIX versioned testing guide; inspect the referenced APISIX Makefile lines for the stated test-nginx invocation. Confirm the repository's POD/README maintenance pattern and preferred location with maintainers, then done means a neutral APISIX entry is added with source links and no behavior changes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nginx, perl
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100