feat(standalone): support JSON format

apisix/cli/file.lua

@@ -287,6 +287,8 @@ function _M.read_yaml_conf(apisix_home)
             default_conf.etcd = default_conf.deployment.etcd
             if default_conf.deployment.role_data_plane.config_provider == "yaml" then
                 default_conf.deployment.config_provider = "yaml"
+            elseif default_conf.deployment.role_data_plane.config_provider == "json" then
+                default_conf.deployment.config_provider = "json"
             elseif default_conf.deployment.role_data_plane.config_provider == "xds" then
                 default_conf.deployment.config_provider = "xds"
             end

apisix/cli/schema.lua

@@ -405,7 +405,7 @@ local deployment_schema = {
             role_data_plane = {
                 properties = {
                     config_provider = {
-                        enum = {"etcd", "yaml", "xds"}
+                        enum = {"etcd", "yaml", "json", "xds"}
                     },
                 },
                 required = {"config_provider"}

apisix/core.lua

@@ -24,7 +24,16 @@ end
 local config_provider = local_conf.deployment and local_conf.deployment.config_provider
                       or "etcd"
 log.info("use config_provider: ", config_provider)
-local config = require("apisix.core.config_" .. config_provider)
+
+local config
+-- Currently, we handle JSON parsing in config_yaml, so special processing is needed here.
+if config_provider == "json" then
+    config = require("apisix.core.config_yaml")
+    config.file_type = "json"
+else
+    config = require("apisix.core.config_" .. config_provider)
+end
+
 config.type = config_provider
 
 

apisix/core/config_yaml.lua

@@ -46,7 +46,6 @@ local ngx          = ngx
 local re_find      = ngx.re.find
 local process      = require("ngx.process")
 local worker_id    = ngx.worker.id
-local apisix_yaml_path = profile:yaml_path("apisix")
 local created_obj  = {}
 local shared_dict
 local status_report_shared_dict_name = "status-report"
@@ -56,6 +55,9 @@ local _M = {
     local_conf = config_local.local_conf,
     clear_local_cache = config_local.clear_cache,
 
+    -- yaml or json
+    file_type = "yaml",
+
     ERR_NO_SHARED_DICT = "failed prepare standalone config shared dict, this will degrade "..
                     "to event broadcasting, and if a worker crashes, the configuration "..
                     "cannot be restored from other workers and shared dict"
@@ -69,10 +71,68 @@ local mt = {
     end
 }
 
-
 local apisix_yaml
 local apisix_yaml_mtime
 
+local config_yaml = {
+    path = profile:yaml_path("apisix"),
+    type = "yaml",
+    parse = function(self)
+        local f, err = io.open(self.path, "r")
+        if not f then
+            return nil, "failed to open file " .. self.path .. " : " .. err
+        end
+
+        f:seek('end', -10)
+        local end_flag = f:read("*a")
+        local found_end_flag = re_find(end_flag, [[#END\s*$]], "jo")
+
+        if not found_end_flag then
+            f:close()
+            return nil, "missing valid end flag in file " .. self.path
+        end
+
+        f:seek('set')
+        local raw_config = f:read("*a")
+        f:close()
+
+        return yaml.load(raw_config), nil
+    end
+}
+
+local config_json = {
+    -- `-5` to remove the "yaml" suffix
+    path = config_yaml.path:sub(1, -5) .. "json",
+    type = "json",
+    parse = function(self)
+        local f, err = io.open(self.path, "r")
+        if not f then
+            return nil, "failed to open file " .. self.path .. " : " .. err
+        end
+        local raw_config = f:read("*a")
+        f:close()
+
+        local config, err = json.decode(raw_config)
+        if err then
+            return nil, "failed to decode json: " .. err
+        end
+        return config, nil
+    end
+}
+
+local config_file_table = {
+    yaml = config_yaml,
+    json = config_json
+}
+
+
+local config_file = setmetatable({}, {
+    __index = function(_, key)
+        return config_file_table[_M.file_type][key]
+    end
+})
+
+
 local function sync_status_to_shdict(status)
     if process.type() ~= "worker" then
         return
@@ -112,13 +172,13 @@ local function is_use_admin_api()
 end
 
 
-local function read_apisix_yaml(premature, pre_mtime)
+local function read_apisix_config(premature, pre_mtime)
     if premature then
         return
     end
-    local attributes, err = lfs.attributes(apisix_yaml_path)
+    local attributes, err = lfs.attributes(config_file.path)
     if not attributes then
-        log.error("failed to fetch ", apisix_yaml_path, " attributes: ", err)
+        log.error("failed to fetch ", config_file.path, " attributes: ", err)
         return
     end
 
@@ -127,36 +187,15 @@ local function read_apisix_yaml(premature, pre_mtime)
         return
     end
 
-    local f, err = io.open(apisix_yaml_path, "r")
-    if not f then
-        log.error("failed to open file ", apisix_yaml_path, " : ", err)
-        return
-    end
-
-    f:seek('end', -10)
-    local end_flag = f:read("*a")
-    -- log.info("flag: ", end_flag)
-    local found_end_flag = re_find(end_flag, [[#END\s*$]], "jo")
-
-    if not found_end_flag then
-        f:close()
-        log.warn("missing valid end flag in file ", apisix_yaml_path)
-        return
-    end
-
-    f:seek('set')
-    local yaml_config = f:read("*a")
-    f:close()
-
-    local apisix_yaml_new = yaml.load(yaml_config)
-    if not apisix_yaml_new then
-        log.error("failed to parse the content of file " .. apisix_yaml_path)
+    local config_new, err = config_file:parse()
+    if err then
+        log.error("failed to parse the content of file " .. config_file.path .. ": " .. err)
         return
     end
 
-    update_config(apisix_yaml_new, last_modification_time)
+    update_config(config_new, last_modification_time)
 
-    log.warn("config file ", apisix_yaml_path, " reloaded.")
+    log.warn("config file ", config_file.path, " reloaded.")
 end
 
 
@@ -171,7 +210,7 @@ local function sync_data(self)
     else
         if not apisix_yaml_mtime then
             log.warn("wait for more time")
-            return nil, "failed to read local file " .. apisix_yaml_path
+            return nil, "failed to read local file " .. config_file.path
         end
         conf_version = apisix_yaml_mtime
     end
@@ -395,15 +434,15 @@ local function _automatic_fetch(premature, self)
         local ok, ok2, err = pcall(sync_data, self)
         if not ok then
             err = ok2
-            log.error("failed to fetch data from local file " .. apisix_yaml_path .. ": ",
+            log.error("failed to fetch data from local file " .. config_file.path .. ": ",
                       err, ", ", tostring(self))
             ngx_sleep(3)
             break
 
         elseif not ok2 and err then
             if err ~= "timeout" and err ~= "Key not found"
                and self.last_err ~= err then
-                log.error("failed to fetch data from local file " .. apisix_yaml_path .. ": ",
+                log.error("failed to fetch data from local file " .. config_file.path .. ": ",
                           err, ", ", tostring(self))
             end
 
@@ -477,7 +516,7 @@ function _M.new(key, opts)
         end
 
         if err then
-            log.error("failed to fetch data from local file ", apisix_yaml_path, ": ",
+            log.error("failed to fetch data from local file ", config_file.path, ": ",
                       err, ", ", key)
         end
 
@@ -517,7 +556,7 @@ function _M.init()
         return true
     end
 
-    read_apisix_yaml()
+    read_apisix_config()
     return true
 end
 
@@ -531,7 +570,7 @@ function _M.init_worker()
     end
 
     -- sync data in each non-master process
-    ngx.timer.every(1, read_apisix_yaml)
+    ngx.timer.every(1, read_apisix_config)
 
     return true
 end

docs/en/latest/deployment-modes.md

@@ -31,7 +31,7 @@ APISIX has three different deployment modes for different production use cases.
 |-----------------|----------------------------|---------------------------------------------------------------------------------------------------------------------|
 | traditional     | traditional                | Data plane and control plane are deployed together. `enable_admin` attribute should be disabled manually.           |
 | decoupled       | data_plane / control_plane | Data plane and control plane are deployed independently.                                                            |
-| standalone      | data_plane / traditional   | The `data_plane` mode loads configuration from a local YAML file, while the traditional mode expects configuration through Admin API.   |
+| standalone      | data_plane / traditional   | The `data_plane` mode loads configuration from a local YAML / JSON file, while the traditional mode expects configuration through Admin API.   |
 
 Each of these deployment modes are explained in detail below.
 
@@ -136,6 +136,8 @@ deployment:
 
 This makes it possible to disable the Admin API and discover configuration changes and reloads based on the local file system.
 
+*Note*: When using `config_provider: yaml`, you can also provide the configuration in JSON format by placing it in `conf/apisix.json`.
+
 #### API-driven (Experimental)
 
 > This mode is experimental, please do not rely on it in your production environment.
@@ -293,7 +295,7 @@ routes:
 #END
 ```
 
-*WARNING*: APISIX will not load the rules into memory from file `conf/apisix.yaml` if there is no `#END` at the end.
+*WARNING*: APISIX will not load the rules into memory from file `conf/apisix.yaml` if there is no `#END` at the end. However, when using `conf/apisix.json`, the `#END` marker is not required, as APISIX can directly parse and validate the JSON structure.
 
 Environment variables can also be used like so:
 
@@ -327,6 +329,23 @@ routes:
 #END
 ```
 
+```json5
+// JSON configuration can be directly translated from YAML, this is just an example.
+{
+  "routes": [
+    {
+      "uri": "/hello",
+      "upstream": {
+        "nodes": {
+          "127.0.0.1:1980": 1
+        },
+        "type": "roundrobin"
+      }
+    }
+  ]
+}
+```
+
 Multiple Routes：
 
 ```yaml

t/APISIX.pm

@@ -125,14 +125,17 @@ my $profile = $ENV{"APISIX_PROFILE"};
 
 
 my $apisix_file;
+my $apisix_file_json;
 my $debug_file;
 my $config_file;
 if ($profile) {
     $apisix_file = "apisix-$profile.yaml";
+    $apisix_file_json = "apisix-$profile.json";
     $debug_file = "debug-$profile.yaml";
     $config_file = "config-$profile.yaml";
 } else {
     $apisix_file = "apisix.yaml";
+    $apisix_file_json = "apisix.json";
     $debug_file = "debug.yaml";
     $config_file = "config.yaml";
 }
@@ -254,6 +257,18 @@ deployment:
 _EOC_
     }
 
+    if ($block->apisix_json && (!defined $block->yaml_config)) {
+        $user_yaml_config = <<_EOC_;
+apisix:
+    node_listen: 1984
+    enable_admin: false
+deployment:
+    role: data_plane
+    role_data_plane:
+        config_provider: json
+_EOC_
+    }
+
     my $lua_deps_path = $block->lua_deps_path // <<_EOC_;
     lua_package_path "$apisix_home/?.lua;$apisix_home/?/init.lua;$apisix_home/deps/share/lua/5.1/?/init.lua;$apisix_home/deps/share/lua/5.1/?.lua;$apisix_home/apisix/?.lua;$apisix_home/t/?.lua;$apisix_home/t/xrpc/?.lua;$apisix_home/t/xrpc/?/init.lua;;";
     lua_package_cpath "$apisix_home/?.so;$apisix_home/deps/lib/lua/5.1/?.so;$apisix_home/deps/lib64/lua/5.1/?.so;;";
@@ -915,6 +930,14 @@ $user_apisix_yaml
 _EOC_
     }
 
+    my $user_apisix_json = $block->apisix_json // "";
+    if ($user_apisix_json){
+        $user_apisix_json = <<_EOC_;
+>>> ../conf/$apisix_file_json
+$user_apisix_json
+_EOC_
+    }
+
     my $yaml_config = $block->yaml_config // $user_yaml_config;
 
     my $default_deployment = <<_EOC_;
@@ -959,6 +982,7 @@ $etcd_pem
 >>> ../conf/cert/etcd.key
 $etcd_key
 $user_apisix_yaml
+$user_apisix_json
 _EOC_
 
     $block->set_value("user_files", $user_files);