{ "version": "3.13.0", "sidebar": [ { "type": "category", "label": "Getting Started", "items": [ "getting-started/README", "getting-started/configure-routes", "getting-started/load-balancing", "getting-started/key-authentication", "getting-started/rate-limiting" ] }, { "type": "doc", "id": "installation-guide" }, { "type": "doc", "id": "architecture-design/apisix" }, { "type": "category", "label": "Tutorials", "items": [ "tutorials/expose-api", "tutorials/protect-api", { "type": "category", "label": "Observability", "items": [ "tutorials/observe-your-api", "tutorials/health-check", "tutorials/monitor-api-health-check" ] }, "tutorials/manage-api-consumers", "tutorials/cache-api-responses", "tutorials/add-multiple-api-versions", "tutorials/client-to-apisix-mtls", "tutorials/websocket-authentication", "tutorials/keycloak-oidc" ] }, { "type": "category", "label": "Terminology", "items": [ "terminology/api-gateway", "terminology/consumer", "terminology/consumer-group", "terminology/credential", "terminology/global-rule", "terminology/plugin", "terminology/plugin-config", "terminology/plugin-metadata", "terminology/route", "terminology/router", "terminology/script", "terminology/service", "terminology/upstream", "terminology/secret" ] }, { "type": "category", "label": "Plugins", "items": [ { "type": "category", "label": "AI", "items": [ "plugins/ai-proxy", "plugins/ai-proxy-multi", "plugins/ai-rate-limiting", "plugins/ai-prompt-guard", "plugins/ai-aws-content-moderation", "plugins/ai-prompt-decorator", "plugins/ai-prompt-template", "plugins/ai-rag", "plugins/ai-request-rewrite" ] }, { "type": "category", "label": "General", "items": [ "plugins/batch-requests", "plugins/redirect", "plugins/echo", "plugins/gzip", "plugins/brotli", "plugins/real-ip", "plugins/server-info", "plugins/ext-plugin-pre-req", "plugins/ext-plugin-post-req", "plugins/ext-plugin-post-resp", "plugins/inspect", "plugins/ocsp-stapling" ] }, { "type": "category", "label": "Transformation", "items": [ "plugins/response-rewrite", "plugins/proxy-rewrite", "plugins/grpc-transcode", "plugins/grpc-web", "plugins/fault-injection", "plugins/mocking", "plugins/degraphql", "plugins/body-transformer", "plugins/attach-consumer-label" ] }, { "type": "category", "label": "Authentication", "items": [ "plugins/key-auth", "plugins/jwt-auth", "plugins/jwe-decrypt", "plugins/basic-auth", "plugins/authz-keycloak", "plugins/authz-casdoor", "plugins/wolf-rbac", "plugins/openid-connect", "plugins/cas-auth", "plugins/hmac-auth", "plugins/authz-casbin", "plugins/ldap-auth", "plugins/opa", "plugins/forward-auth", "plugins/multi-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", "plugins/gm", "plugins/chaitin-waf" ] }, { "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", "plugins/workflow" ] }, { "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", "plugins/elasticsearch-logger", "plugins/tencent-cloud-cls", "plugins/loki-logger", "plugins/lago" ] } ] }, { "type": "category", "label": "Serverless", "items": [ "plugins/serverless", "plugins/azure-functions", "plugins/openwhisk", "plugins/aws-lambda", "plugins/openfunction" ] }, { "type": "category", "label": "Other protocols", "items": [ "plugins/dubbo-proxy", "plugins/mqtt-proxy", "plugins/kafka-proxy", "plugins/http-dubbo" ] } ] }, { "type": "category", "label": "API", "items": [ { "type": "doc", "id": "admin-api" }, { "type": "doc", "id": "control-api" }, { "type": "doc", "id": "status-api" } ] }, { "type": "category", "label": "Development", "items": [ { "type": "doc", "id": "build-apisix-dev-environment-devcontainers" }, { "type": "doc", "id": "building-apisix" }, { "type": "doc", "id": "build-apisix-dev-environment-on-mac" }, { "type": "doc", "id": "support-fips-in-apisix" }, { "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": "category", "label": "internal", "items": [ "internal/plugin-runner", "internal/testing-framework" ] }, { "type": "doc", "id": "plugin-develop" }, { "type": "doc", "id": "debug-mode" } ] }, { "type": "doc", "id": "deployment-modes" }, { "type": "doc", "id": "FAQ" }, { "type": "category", "label": "Others", "items": [ { "type": "category", "label": "Discovery", "items": [ "discovery", "discovery/dns", "discovery/consul", "discovery/consul_kv", "discovery/nacos", "discovery/eureka", "discovery/control-plane-service-discovery", "discovery/kubernetes" ] }, { "type": "category", "label": "PubSub", "items": [ "pubsub", "pubsub/kafka" ] }, { "type": "category", "label": "xRPC", "items": [ "xrpc/redis", "xrpc" ] }, { "type": "doc", "id": "router-radixtree" }, { "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": "apisix-variable" }, { "type": "doc", "id": "aws" }, { "type": "doc", "id": "mtls" }, { "type": "doc", "id": "debug-function" }, { "type": "doc", "id": "profile" }, { "type": "doc", "id": "ssl-protocol" }, { "type": "doc", "id": "http3" } ] }, { "type": "link", "label": "CHANGELOG", "href": "https://github.com/apache/apisix/blob/master/CHANGELOG.md" }, { "type": "doc", "id": "upgrade-guide-from-2.15.x-to-3.0.0" } ] }