apisix/docs/en/latest/config.json

{
  "version": "2.12.0",
  "sidebar": [
    {
      "type": "category",
      "label": "Architecture Design",
      "items": [
        "architecture-design/apisix",
        "architecture-design/route",
        "architecture-design/plugin",
        "architecture-design/script",
        "architecture-design/service",
        "architecture-design/consumer",
        "architecture-design/upstream",
        "architecture-design/global-rule",
        "architecture-design/plugin-config",
        "architecture-design/router",
        "architecture-design/debug-mode"
      ]
    },
    {
      "type": "doc",
      "id": "getting-started"
    },
    {
      "type": "doc",
      "id": "how-to-build"
    },
    {
      "type": "category",
      "label": "Plugins",
      "items": [
        {
          "type": "category",
          "label": "General",
          "items": [
            "plugins/batch-requests",
            "plugins/redirect",
            "plugins/echo",
            "plugins/gzip",
            "plugins/real-ip",
            "plugins/server-info",
            "plugins/ext-plugin-pre-req",
            "plugins/ext-plugin-post-req"
          ]
        },
        {
          "type": "category",
          "label": "Transformation",
          "items": [
            "plugins/response-rewrite",
            "plugins/proxy-rewrite",
            "plugins/grpc-transcode",
            "plugins/grpc-web",
            "plugins/fault-injection",
            "plugins/mocking"
          ]
        },
        {
          "type": "category",
          "label": "Authentication",
          "items": [
            "plugins/key-auth",
            "plugins/jwt-auth",
            "plugins/basic-auth",
            "plugins/authz-keycloak",
            "plugins/wolf-rbac",
            "plugins/openid-connect",
            "plugins/hmac-auth",
            "plugins/authz-casbin",
            "plugins/ldap-auth",
            "plugins/opa",
            "plugins/forward-auth"
          ]
        },
        {
          "type": "category",
          "label": "Security",
          "items": [
            "plugins/cors",
            "plugins/uri-blocker",
            "plugins/ip-restriction",
            "plugins/ua-restriction",
            "plugins/referer-restriction",
            "plugins/consumer-restriction",
            "plugins/csrf",
            "plugins/public-api"
          ]
        },
        {
          "type": "category",
          "label": "Traffic",
          "items": [
            "plugins/limit-req",
            "plugins/limit-conn",
            "plugins/limit-count",
            "plugins/proxy-cache",
            "plugins/request-validation",
            "plugins/proxy-mirror",
            "plugins/api-breaker",
            "plugins/traffic-split",
            "plugins/request-id",
            "plugins/proxy-control",
            "plugins/client-control"
          ]
        },
        {
          "type": "category",
          "label": "Observability",
          "items": [
            {
              "type": "category",
              "label": "Tracers",
              "items": [
                "plugins/zipkin",
                "plugins/skywalking",
                "plugins/opentelemetry"
              ]
            },
            {
              "type": "category",
              "label": "Metrics",
              "items": [
                "plugins/prometheus",
                "plugins/node-status",
                "plugins/datadog"
              ]
            },
            {
              "type": "category",
              "label": "Loggers",
              "items": [
                "plugins/http-logger",
                "plugins/skywalking-logger",
                "plugins/tcp-logger",
                "plugins/kafka-logger",
                "plugins/rocketmq-logger",
                "plugins/udp-logger",
                "plugins/clickhouse-logger",
                "plugins/syslog",
                "plugins/log-rotate",
                "plugins/error-log-logger",
                "plugins/sls-logger",
                "plugins/google-cloud-logging",
                "plugins/splunk-hec-logging",
                "plugins/file-logger",
                "plugins/loggly"
              ]
            }
          ]
        },
        {
          "type": "category",
          "label": "Serverless",
          "items": [
            "plugins/serverless",
            "plugins/azure-functions",
            "plugins/openwhisk",
            "plugins/aws-lambda"
          ]
        },
        {
          "type": "category",
          "label": "Other Protocols",
          "items": [
            "plugins/dubbo-proxy",
            "plugins/mqtt-proxy"
          ]
        }
      ]
    },
    {
      "type": "category",
      "label": "API",
      "items": [
        {
          "type": "doc",
          "id": "admin-api"
        },
        {
          "type": "doc",
          "id": "control-api"
        }
      ]
    },
    {
      "type": "doc",
      "id": "FAQ"
    },
    {
      "type": "category",
      "label": "Others",
      "items": [
        {
          "type": "category",
          "label": "Discovery",
          "items": [
            "discovery",
            "discovery/dns",
            "discovery/consul_kv",
            "discovery/nacos",
            "discovery/eureka"
          ]
        },
        {
          "type": "doc",
          "id": "health-check"
        },
        {
          "type": "doc",
          "id": "router-radixtree"
        },
        {
          "type": "doc",
          "id": "stand-alone"
        },
        {
          "type": "doc",
          "id": "stream-proxy"
        },
        {
          "type": "doc",
          "id": "grpc-proxy"
        },
        {
          "type": "doc",
          "id": "customize-nginx-configuration"
        },
        {
          "type": "doc",
          "id": "certificate"
        },
        {
          "type": "doc",
          "id": "batch-processor"
        },
        {
          "type": "doc",
          "id": "benchmark"
        },
        {
          "type": "doc",
          "id": "install-dependencies"
        },
        {
          "type": "doc",
          "id": "plugin-develop"
        },
        {
          "type": "doc",
          "id": "apisix-variable"
        },
        {
          "type": "doc",
          "id": "external-plugin"
        },
        {
          "type": "doc",
          "id": "wasm"
        },
        {
          "type": "link",
          "label": "CODE_STYLE",
          "href": "https://github.com/apache/apisix/blob/master/CODE_STYLE.md"
        },
        {
          "type": "doc",
          "id": "aws"
        },
        {
          "type": "doc",
          "id": "mtls"
        },
        {
          "type": "doc",
          "id": "debug-function"
        },
        {
          "type": "category",
          "label": "internal",
          "items": [
            "internal/plugin-runner",
            "internal/testing-framework"
          ]
        },
        {
          "type": "doc",
          "id": "profile"
        }
      ]
    },
    {
      "type": "link",
      "label": "CHANGELOG",
      "href": "https://github.com/apache/apisix/blob/master/CHANGELOG.md"
    }
  ]
}