feat: add validate API to standalone mode by Revolyssup · Pull Request #12718 · apache/apisix

Revolyssup · 2025-10-30T14:50:46Z

Provide a validate API for standalone mode that only validate input like admin api but does not save input to memory.
Required for ingress controller to validate plugin configurations that convert from CRD.

Checklist

I have explained the need for this PR and the problem it solves
I have explained the changes or the new features added to this PR
I have added tests corresponding to this change
I have updated the documentation to reflect this change
I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

AlinsRan · 2025-11-19T08:16:07Z

The CI failure is not related to the current PR modification.

membphis

LGTM, only some minor code style issues

membphis · 2025-11-19T08:24:39Z

+        end
+    end
+
+    if collect_all_errors then


code style

if collect_all_errors then return validation_results.valid, validation_results end return validation_results.valid

membphis · 2025-11-19T08:26:09Z

+
+    local valid, validation_results = validate_configuration(data, true)
+
+    if valid then


if not valid then return core.response.exit(400, { error_msg = "Configuration validation failed", valid = false, errors = validation_results.errors }) end return core.response.exit(200, { message = "Configuration is valid", valid = true })

bzp2010 · 2025-11-21T02:42:09Z

+            error_msg = "Configuration validation failed",
+            valid = false,
+            errors = validation_results.errors
+        })
+    end
+
+    return core.response.exit(200, {
+        message = "Configuration is valid",
+        valid = true
+    })


When the check passes, neither the message nor the valid field carries any meaning; an HTTP 200 response is sufficient to imply this outcome. In practice, neither of these return fields will be utilised anywhere. Remove them.

When the check fails, the valid field similarly holds no significance. An HTTP 400 response can indicate this error. Remove it. The error_msg should maintain a consistent style, using lowercase initial letters.

bzp2010 · 2025-11-21T03:43:20Z

+    it('validate config (success case with json)', async () => {
+      const resp = await client.post(`${ENDPOINT}/validate`, config1);
+      expect(resp.status).toEqual(200);
+      expect(resp.data).toEqual({
+        message: 'Configuration is valid',
+        valid: true,
+      });
+    });
+
+    it('validate config (success case with yaml)', async () => {
+      const resp = await client.post(`${ENDPOINT}/validate`, YAML.stringify(config1), {
+        headers: { 'Content-Type': 'application/yaml' },
+      });
+      expect(resp.status).toEqual(200);
+      expect(resp.data).toEqual({
+        message: 'Configuration is valid',
+        valid: true,
+      });
+    });
+
+    it('validate config (success case with multiple resources)', async () => {
+      const multiResourceConfig = {
+        routes: [
+          {
+            id: 'r1',
+            uri: '/r1',
+            upstream: {
+              nodes: { '127.0.0.1:1980': 1 },
+              type: 'roundrobin',
+            },
+          },
+          {
+            id: 'r2',
+            uri: '/r2',
+            upstream: {
+              nodes: { '127.0.0.1:1980': 1 },
+              type: 'roundrobin',
+            },
+          },
+        ],
+        services: [
+          {
+            id: 's1',
+            upstream: {
+              nodes: { '127.0.0.1:1980': 1 },
+              type: 'roundrobin',
+            },
+          },
+        ],
+        routes_conf_version: 1,
+        services_conf_version: 1,
+      };
+
+      const resp = await client.post(`${ENDPOINT}/validate`, multiResourceConfig);
+      expect(resp.status).toEqual(200);
+      expect(resp.data).toEqual({
+        message: 'Configuration is valid',
+        valid: true,
+      });
+    });
+
+    it('validate config with consumer credentials', async () => {
+      const resp = await client.post(`${ENDPOINT}/validate`, credential1);
+      expect(resp.status).toEqual(200);
+      expect(resp.data).toEqual({
+        message: 'Configuration is valid',
+        valid: true,
+      });
+    });
+
+    it('validate config does not persist changes', async () => {
+      // First validate a configuration
+      const validateResp = await client.post(`${ENDPOINT}/validate`, config1);
+      expect(validateResp.status).toEqual(200);
+
+      // Then check that the configuration was not persisted
+      const getResp = await client.get(ENDPOINT);
+      expect(getResp.data.routes).toBeUndefined();
+    });


I recommend moving these validate API tests to a separate describe block, which will help achieve a clearer separation.

bzp2010 · 2025-11-21T03:47:53Z

+      const resp = await client.post(`${ENDPOINT}/validate`, credential1);
+      expect(resp.status).toEqual(200);
+      expect(resp.data).toEqual({
+        message: 'Configuration is valid',


This message does not need assertion, as checking such constant strings is meaningless. You may switch to the toMatchObject API to assert fields other than message. Only fields expected to exist in the configuration will be checked.

If no further assertion of the response is required, then only assert the response status code.

bzp2010 · 2025-11-21T03:50:49Z

          'invalid routes at index 0, err: invalid configuration: failed to match pattern "^((uri|server_name|server_addr|request_uri|remote_port|remote_addr|query_string|host|hostname|mqtt_client_id)|arg_[0-9a-zA-z_-]+)$" with "args_invalid"',
      });
    });
+    it('validate config (duplicate route id)', async () => {


What is the purpose of these newly added tests? Did we previously have duplicate ID checking functionality without test coverage?

The target API for testing is different, here we are testing the validate API.

feat: add validate API to standalone mode

c67bfab

dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. enhancement New feature or request labels Oct 30, 2025

f

25bba3c

Revolyssup requested review from bzp2010, membphis and nic-6443 and removed request for bzp2010 October 30, 2025 14:52

Revolyssup assigned AlinsRan Oct 30, 2025

fix lint

da12d55

nic-6443 reviewed Oct 31, 2025

View reviewed changes

Comment thread apisix/admin/standalone.lua Outdated

Revolyssup added 3 commits October 31, 2025 12:53

apply suggestion

5d214db

f

188fa06

f

2789a0f

nic-6443 requested a review from AlinsRan November 7, 2025 01:07

AlinsRan reviewed Nov 10, 2025

View reviewed changes

Comment thread apisix/admin/standalone.lua Outdated

membphis reviewed Nov 13, 2025

View reviewed changes

Comment thread apisix/admin/standalone.lua

remove redundant code

e0d83b2

dosubot Bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Nov 19, 2025

AlinsRan and others added 2 commits November 19, 2025 08:17

fix lint

9d32ac1

fix lint2

b0be53b

AlinsRan force-pushed the revolyssup/standalone-validate branch from 8f48941 to b0be53b Compare November 19, 2025 01:37

AlinsRan requested review from membphis and nic-6443 November 19, 2025 08:13

membphis previously approved these changes Nov 19, 2025

View reviewed changes

AlinsRan added 2 commits November 20, 2025 10:33

update conmments

84631ce

Merge branch 'master' into revolyssup/standalone-validate

fec1b1a

AlinsRan dismissed membphis’s stale review via fec1b1a November 20, 2025 02:34

fix test

7355892

AlinsRan force-pushed the revolyssup/standalone-validate branch from 1849cb3 to 7355892 Compare November 20, 2025 05:45

Merge branch 'master' into revolyssup/standalone-validate

fc8b3fb

bzp2010 reviewed Nov 21, 2025

View reviewed changes

update message and test

64e8db2

dosubot Bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:XL This PR changes 500-999 lines, ignoring generated files. labels Nov 24, 2025

update test

ee598b3

dosubot Bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:L This PR changes 100-499 lines, ignoring generated files. labels Nov 24, 2025

f

40b52bc

AlinsRan requested a review from bzp2010 November 24, 2025 06:04

nic-6443 approved these changes Nov 24, 2025

View reviewed changes

bzp2010 approved these changes Nov 24, 2025

View reviewed changes

AlinsRan requested a review from membphis November 25, 2025 01:07

membphis approved these changes Nov 25, 2025

View reviewed changes

Baoyuantop merged commit 896d3c3 into apache:master Nov 25, 2025
50 of 53 checks passed

wistefan pushed a commit to wistefan/apisix that referenced this pull request Jun 16, 2026

feat: add validate API to standalone mode (apache#12718)

b5347c2


		local valid, validation_results = validate_configuration(data, true)

		if valid then

Uh oh!

Conversation

Revolyssup commented Oct 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Checklist

Uh oh!

Uh oh!

Uh oh!

Uh oh!

AlinsRan commented Nov 19, 2025

Uh oh!

membphis left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

Revolyssup commented Oct 30, 2025 •

edited

Loading