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:
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
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
Makefileruns the suite withproveand thetest-nginxlibrary path.Evidence:
Makefile: https://github.com/apache/apisix/blob/3.17.0/Makefile#L420-L425Proposed 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:
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