# API7 中文文档 > AISIX AI 网关、AISIX Cloud、Apache APISIX、API7 网关、API7 Ingress Controller、APISIX Ingress Controller 以及网关插件的官方中文文档。 ## hub 探索 Apache APISIX 与 API7 网关的插件文档，包括适用于网关和 Ingress Controller 工作流的配置参考与示例。 - [欢迎来到 API 网关插件中心](https://docs.apiseven.com/hub.md): 探索 Apache APISIX 与 API7 网关的插件文档，包括适用于网关和 Ingress Controller 工作流的配置参考与示例。 ### acl ACL（访问控制列表）插件通过验证用户是否在允许列表中，精细控制对 Apache APISIX 上游资源的访问权限，为企业级 API 网关提供强大的授权管理能力。 - [acl](https://docs.apiseven.com/hub/acl.md): ACL（访问控制列表）插件通过验证用户是否在允许列表中，精细控制对 Apache APISIX 上游资源的访问权限，为企业级 API 网关提供强大的授权管理能力。 #### configuration 参数 - [ACL](https://docs.apiseven.com/hub/acl/configuration.md): 参数 ### ai-aliyun-content-moderation AI Aliyun Content Moderation 插件集成阿里云内容安全服务，在 AI 网关代理 LLM 请求时实时检测提示词输入风险，自动拦截超过安全阈值的请求，保障 AI 应用合规。 - [ai-aliyun-content-moderation](https://docs.apiseven.com/hub/ai-aliyun-content-moderation.md): AI Aliyun Content Moderation 插件集成阿里云内容安全服务，在 AI 网关代理 LLM 请求时实时检测提示词输入风险，自动拦截超过安全阈值的请求，保障 AI 应用合规。 #### configuration 参数 - [AI Aliyun Content Moderation](https://docs.apiseven.com/hub/ai-aliyun-content-moderation/configuration.md): 参数 ### ai-aws-content-moderation AI AWS Content Moderation 插件集成 AWS Comprehend，在 AI 网关代理 LLM 请求时检测提示词毒性内容，自动拦截超过阈值的有害请求，保障 AI 应用安全合规。 - [ai-aws-content-moderation](https://docs.apiseven.com/hub/ai-aws-content-moderation.md): AI AWS Content Moderation 插件集成 AWS Comprehend，在 AI 网关代理 LLM 请求时检测提示词毒性内容，自动拦截超过阈值的有害请求，保障 AI 应用安全合规。 #### configuration 参数 - [AI AWS Content Moderation](https://docs.apiseven.com/hub/ai-aws-content-moderation/configuration.md): 参数 ### ai-cache ai-cache 插件将 LLM 响应缓存在 Redis 中，并直接从缓存返回相同的请求，从而降低延迟、减少上游模型用量。 - [ai-cache 企业版](https://docs.apiseven.com/hub/ai-cache.md): ai-cache 插件将 LLM 响应缓存在 Redis 中，并直接从缓存返回相同的请求，从而降低延迟、减少上游模型用量。 #### configuration 参数 - [AI Cache](https://docs.apiseven.com/hub/ai-cache/configuration.md): 参数 ### ai-lakera-guard ai-lakera-guard 插件通过 Lakera Guard API 筛查 AI 流量，检测请求和 LLM 响应中的提示词注入及其他不安全内容。 - [ai-lakera-guard](https://docs.apiseven.com/hub/ai-lakera-guard.md): ai-lakera-guard 插件通过 Lakera Guard API 筛查 AI 流量，检测请求和 LLM 响应中的提示词注入及其他不安全内容。 #### configuration 参数 - [AI Lakera Guard](https://docs.apiseven.com/hub/ai-lakera-guard/configuration.md): 参数 ### ai-prompt-decorator AI Prompt Decorator 插件在 AI 网关层为 LLM 请求的用户提示词自动添加前缀和后缀，无需修改客户端代码即可统一注入系统指令，简化 AI API 管理与内容生成流程。 - [ai-prompt-decorator](https://docs.apiseven.com/hub/ai-prompt-decorator.md): AI Prompt Decorator 插件在 AI 网关层为 LLM 请求的用户提示词自动添加前缀和后缀，无需修改客户端代码即可统一注入系统指令，简化 AI API 管理与内容生成流程。 #### configuration 参数 - [AI Prompt Decorator](https://docs.apiseven.com/hub/ai-prompt-decorator/configuration.md): 参数 ### ai-prompt-guard AI Prompt Guard 插件通过允许/拒绝模式在 AI 网关层过滤 LLM 提示词，支持检查最新消息或完整对话历史，有效防止提示词注入攻击，保障 AI 应用安全。 - [ai-prompt-guard](https://docs.apiseven.com/hub/ai-prompt-guard.md): AI Prompt Guard 插件通过允许/拒绝模式在 AI 网关层过滤 LLM 提示词，支持检查最新消息或完整对话历史，有效防止提示词注入攻击，保障 AI 应用安全。 #### configuration 参数 - [AI Prompt Guard](https://docs.apiseven.com/hub/ai-prompt-guard/configuration.md): 参数 ### ai-prompt-template AI Prompt Template 插件为 AI 网关提供预配置提示词模板，支持以填空方式让客户端传入变量，统一规范发送给 LLM 的请求格式，简化 AI API 管理与集成。 - [ai-prompt-template](https://docs.apiseven.com/hub/ai-prompt-template.md): AI Prompt Template 插件为 AI 网关提供预配置提示词模板，支持以填空方式让客户端传入变量，统一规范发送给 LLM 的请求格式，简化 AI API 管理与集成。 #### configuration 参数 - [AI Prompt Template](https://docs.apiseven.com/hub/ai-prompt-template/configuration.md): 参数 ### ai-proxy AI Proxy 插件将 API 网关请求转换为 OpenAI、DeepSeek、Anthropic、Gemini 等 LLM 所需格式，支持多模型统一接入，并可在访问日志中记录 Token 用量和首字节响应时间。 - [ai-proxy](https://docs.apiseven.com/hub/ai-proxy.md): AI Proxy 插件将 API 网关请求转换为 OpenAI、DeepSeek、Anthropic、Gemini 等 LLM 所需格式，支持多模型统一接入，并可在访问日志中记录 Token 用量和首字节响应时间。 #### configuration 参数 - [AI Proxy](https://docs.apiseven.com/hub/ai-proxy/configuration.md): 参数 ### ai-proxy-multi AI Proxy Multi 插件支持在 API 网关层配置多个模型服务提供方，实现智能负载均衡与故障转移，确保 AI 服务的高可用性，简化多模型 AI 应用的接入与管理。 - [ai-proxy-multi](https://docs.apiseven.com/hub/ai-proxy-multi.md): AI Proxy Multi 插件支持在 API 网关层配置多个模型服务提供方，实现智能负载均衡与故障转移，确保 AI 服务的高可用性，简化多模型 AI 应用的接入与管理。 #### configuration 参数 - [AI Proxy Multi](https://docs.apiseven.com/hub/ai-proxy-multi/configuration.md): 参数 ### ai-rag AI RAG 插件在 API 网关层实现检索增强生成（RAG），自动检索相关文档并注入 LLM 上下文，提升 AI 响应的准确性和相关性，无需修改后端服务即可增强 AI 能力。 - [ai-rag](https://docs.apiseven.com/hub/ai-rag.md): AI RAG 插件在 API 网关层实现检索增强生成（RAG），自动检索相关文档并注入 LLM 上下文，提升 AI 响应的准确性和相关性，无需修改后端服务即可增强 AI 能力。 #### configuration 插件参数 - [AI RAG](https://docs.apiseven.com/hub/ai-rag/configuration.md): 插件参数 ### ai-rate-limiting AI Rate Limiting 插件专为 AI 网关设计，基于 Token 用量对 LLM API 请求进行速率限制，有效控制 AI 服务成本，防止资源滥用，保障 AI API 的稳定可用性。 - [ai-rate-limiting](https://docs.apiseven.com/hub/ai-rate-limiting.md): AI Rate Limiting 插件专为 AI 网关设计，基于 Token 用量对 LLM API 请求进行速率限制，有效控制 AI 服务成本，防止资源滥用，保障 AI API 的稳定可用性。 #### configuration 参数 - [AI Rate Limiting](https://docs.apiseven.com/hub/ai-rate-limiting/configuration.md): 参数 ### ai-request-rewrite AI Request Rewrite 插件在 API 网关层动态改写发往 LLM 的请求参数，支持修改模型、温度等配置，实现请求的灵活路由与转换，简化 AI 服务的统一管理。 - [ai-request-rewrite](https://docs.apiseven.com/hub/ai-request-rewrite.md): AI Request Rewrite 插件在 API 网关层动态改写发往 LLM 的请求参数，支持修改模型、温度等配置，实现请求的灵活路由与转换，简化 AI 服务的统一管理。 #### configuration 参数 - [AI Request Rewrite](https://docs.apiseven.com/hub/ai-request-rewrite/configuration.md): 参数 ### attach-consumer-label Attach Consumer Label 插件为经过身份认证的消费者请求自动附加标签，便于在 Apache APISIX 中实现基于消费者属性的精细化流量管理、监控和访问控制策略。 - [attach-consumer-label](https://docs.apiseven.com/hub/attach-consumer-label.md): Attach Consumer Label 插件为经过身份认证的消费者请求自动附加标签，便于在 Apache APISIX 中实现基于消费者属性的精细化流量管理、监控和访问控制策略。 #### configuration 参数 - [Attach Consumer Label](https://docs.apiseven.com/hub/attach-consumer-label/configuration.md): 参数 ### authz-keycloak Authz Keycloak 插件将 Apache APISIX 与 Keycloak 授权服务集成，支持基于策略的细粒度访问控制，为 API 网关提供企业级的身份与访问管理（IAM）能力。 - [authz-keycloak](https://docs.apiseven.com/hub/authz-keycloak.md): Authz Keycloak 插件将 Apache APISIX 与 Keycloak 授权服务集成，支持基于策略的细粒度访问控制，为 API 网关提供企业级的身份与访问管理（IAM）能力。 #### configuration 参数 - [Authz Keycloak](https://docs.apiseven.com/hub/authz-keycloak/configuration.md): 参数 ### aws-lambda AWS Lambda 插件将 Apache APISIX 与 AWS Lambda 无服务器函数集成，支持将 API 请求直接代理到 Lambda 函数，实现 Serverless 架构下的 API 网关统一管理。 - [aws-lambda](https://docs.apiseven.com/hub/aws-lambda.md): AWS Lambda 插件将 Apache APISIX 与 AWS Lambda 无服务器函数集成，支持将 API 请求直接代理到 Lambda 函数，实现 Serverless 架构下的 API 网关统一管理。 #### configuration 属性 - [AWS Lambda](https://docs.apiseven.com/hub/aws-lambda/configuration.md): 属性 ### basic-auth Basic Auth 插件为 Apache APISIX 路由添加 HTTP 基本访问认证，要求客户端提供用户名和密码才能访问上游资源，快速为 API 网关启用简单身份认证保护。 - [basic-auth](https://docs.apiseven.com/hub/basic-auth.md): Basic Auth 插件为 Apache APISIX 路由添加 HTTP 基本访问认证，要求客户端提供用户名和密码才能访问上游资源，快速为 API 网关启用简单身份认证保护。 #### configuration 参数 - [Basic Auth](https://docs.apiseven.com/hub/basic-auth/configuration.md): 参数 ### body-transformer Body Transformer 插件在 API 网关层对请求和响应的消息体进行格式转换，支持 JSON 与 XML 互转及自定义模板，实现不同系统间的数据格式无缝对接。 - [body-transformer](https://docs.apiseven.com/hub/body-transformer.md): Body Transformer 插件在 API 网关层对请求和响应的消息体进行格式转换，支持 JSON 与 XML 互转及自定义模板，实现不同系统间的数据格式无缝对接。 #### configuration 参数 - [Body Transformer](https://docs.apiseven.com/hub/body-transformer/configuration.md): 参数 ### chaitin-waf Chaitin WAF 插件将长亭科技 Web 应用防火墙集成到 Apache APISIX，在 API 网关层实时检测并拦截 SQL 注入、XSS 等 Web 攻击，为 API 提供企业级安全防护。 - [chaitin-waf](https://docs.apiseven.com/hub/chaitin-waf.md): Chaitin WAF 插件将长亭科技 Web 应用防火墙集成到 Apache APISIX，在 API 网关层实时检测并拦截 SQL 注入、XSS 等 Web 攻击，为 API 提供企业级安全防护。 #### configuration 参数 - [Chaitin WAF](https://docs.apiseven.com/hub/chaitin-waf/configuration.md): 参数 ### clickhouse-logger ClickHouse Logger 插件将 Apache APISIX 的 API 访问日志实时写入 ClickHouse 数据库，支持高吞吐量日志存储与分析，为 API 网关的可观测性提供强大数据支撑。 - [clickhouse-logger](https://docs.apiseven.com/hub/clickhouse-logger.md): ClickHouse Logger 插件将 Apache APISIX 的 API 访问日志实时写入 ClickHouse 数据库，支持高吞吐量日志存储与分析，为 API 网关的可观测性提供强大数据支撑。 #### configuration 参数 - [ClickHouse Logger](https://docs.apiseven.com/hub/clickhouse-logger/configuration.md): 参数 ### consumer-restriction Consumer Restriction 插件基于消费者身份对 Apache APISIX 路由访问进行精细控制，支持白名单和黑名单模式，实现 API 网关层的消费者级别访问授权管理。 - [consumer-restriction](https://docs.apiseven.com/hub/consumer-restriction.md): Consumer Restriction 插件基于消费者身份对 Apache APISIX 路由访问进行精细控制，支持白名单和黑名单模式，实现 API 网关层的消费者级别访问授权管理。 #### configuration 参数 - [Consumer Restriction](https://docs.apiseven.com/hub/consumer-restriction/configuration.md): 参数 ### cors CORS 插件为 Apache APISIX 路由启用跨源资源共享（CORS），支持灵活配置允许的来源、方法和请求头，解决前端跨域问题，提升 API 的可访问性与兼容性。 - [cors](https://docs.apiseven.com/hub/cors.md): CORS 插件为 Apache APISIX 路由启用跨源资源共享（CORS），支持灵活配置允许的来源、方法和请求头，解决前端跨域问题，提升 API 的可访问性与兼容性。 #### configuration 参数 - [CORS](https://docs.apiseven.com/hub/cors/configuration.md): 参数 ### data-mask Data Mask 插件在 Apache APISIX 日志记录前对敏感字段进行脱敏处理，支持自定义掩码规则，保护用户隐私数据，帮助 API 网关满足数据安全合规要求。 - [data-mask](https://docs.apiseven.com/hub/data-mask.md): Data Mask 插件在 Apache APISIX 日志记录前对敏感字段进行脱敏处理，支持自定义掩码规则，保护用户隐私数据，帮助 API 网关满足数据安全合规要求。 #### configuration 参数 - [Data Mask](https://docs.apiseven.com/hub/data-mask/configuration.md): 参数 ### datadog Datadog 插件将 Apache APISIX 的 API 指标和追踪数据推送到 Datadog 监控平台，实现 API 网关的全链路可观测性，帮助团队快速发现和诊断性能问题。 - [datadog](https://docs.apiseven.com/hub/datadog.md): Datadog 插件将 Apache APISIX 的 API 指标和追踪数据推送到 Datadog 监控平台，实现 API 网关的全链路可观测性，帮助团队快速发现和诊断性能问题。 #### configuration 参数 - [Datadog](https://docs.apiseven.com/hub/datadog/configuration.md): 参数 ### degraphql DeGraphQL 插件将 RESTful API 请求转换为 GraphQL 查询，让客户端无需了解 GraphQL 语法即可访问 GraphQL 后端，通过 API 网关实现 REST 到 GraphQL 的无缝桥接。 - [degraphql](https://docs.apiseven.com/hub/degraphql.md): DeGraphQL 插件将 RESTful API 请求转换为 GraphQL 查询，让客户端无需了解 GraphQL 语法即可访问 GraphQL 后端，通过 API 网关实现 REST 到 GraphQL 的无缝桥接。 #### configuration 参数 - [degraphql](https://docs.apiseven.com/hub/degraphql/configuration.md): 参数 ### dingtalk-auth dingtalk-auth 插件提供了钉钉 OAuth 2.0 身份认证能力，验证客户端请求中携带的免登录授权码并获取用户信息，适用于钉钉企业内部应用的访问控制场景。 - [dingtalk-auth 企业版](https://docs.apiseven.com/hub/dingtalk-auth.md): dingtalk-auth 插件提供了钉钉 OAuth 2.0 身份认证能力，验证客户端请求中携带的免登录授权码并获取用户信息，适用于钉钉企业内部应用的访问控制场景。 #### configuration 参数 - [DingTalk Auth](https://docs.apiseven.com/hub/dingtalk-auth/configuration.md): 参数 ### elasticsearch-logger Elasticsearch Logger 插件将 Apache APISIX 的 API 访问日志实时推送到 Elasticsearch，结合 Kibana 实现日志的可视化分析，增强 API 网关的可观测性与故障排查能力。 - [elasticsearch-logger](https://docs.apiseven.com/hub/elasticsearch-logger.md): Elasticsearch Logger 插件将 Apache APISIX 的 API 访问日志实时推送到 Elasticsearch，结合 Kibana 实现日志的可视化分析，增强 API 网关的可观测性与故障排查能力。 #### configuration 参数 - [Elasticsearch Logger](https://docs.apiseven.com/hub/elasticsearch-logger/configuration.md): 参数 ### error-log-collect Error Log Collect 插件捕获处理指定请求时产生的错误日志，包括所配置日志级别通常会丢弃的低级别日志，并将其写入网关错误日志，便于针对性调试。 - [error-log-collect 企业版](https://docs.apiseven.com/hub/error-log-collect.md): Error Log Collect 插件捕获处理指定请求时产生的错误日志，包括所配置日志级别通常会丢弃的低级别日志，并将其写入网关错误日志，便于针对性调试。 #### configuration 参数 - [Error Log Collect](https://docs.apiseven.com/hub/error-log-collect/configuration.md): 参数 ### error-log-logger Error Log Logger 插件将 Apache APISIX 产生的错误日志推送到远程日志服务，支持集中化错误日志管理，帮助运维团队及时发现和处理 API 网关的异常情况。 - [error-log-logger](https://docs.apiseven.com/hub/error-log-logger.md): Error Log Logger 插件将 Apache APISIX 产生的错误日志推送到远程日志服务，支持集中化错误日志管理，帮助运维团队及时发现和处理 API 网关的异常情况。 #### configuration 参数 - [Error Log Logger](https://docs.apiseven.com/hub/error-log-logger/configuration.md): 参数 ### error-page Error Page 插件允许为 Apache APISIX 自定义 HTTP 错误响应页面，支持按状态码配置个性化错误内容，提升 API 网关错误处理的用户体验和品牌一致性。 - [error-page 企业版](https://docs.apiseven.com/hub/error-page.md): Error Page 插件允许为 Apache APISIX 自定义 HTTP 错误响应页面，支持按状态码配置个性化错误内容，提升 API 网关错误处理的用户体验和品牌一致性。 #### configuration 参数 - [Error Page](https://docs.apiseven.com/hub/error-page/configuration.md): 参数 ### exit-transformer Exit Transformer 插件在 Apache APISIX 返回响应前对响应体进行自定义转换，支持修改状态码、响应头和响应体，实现 API 网关层的统一响应格式标准化。 - [exit-transformer 企业版](https://docs.apiseven.com/hub/exit-transformer.md): Exit Transformer 插件在 Apache APISIX 返回响应前对响应体进行自定义转换，支持修改状态码、响应头和响应体，实现 API 网关层的统一响应格式标准化。 #### configuration 参数 - [Exit Transformer](https://docs.apiseven.com/hub/exit-transformer/configuration.md): 参数 ### fault-injection Fault Injection 插件在 Apache APISIX 中模拟 API 故障场景，支持注入延迟和自定义错误响应，用于混沌工程测试，验证微服务架构在 API 网关层的容错能力。 - [fault-injection](https://docs.apiseven.com/hub/fault-injection.md): Fault Injection 插件在 Apache APISIX 中模拟 API 故障场景，支持注入延迟和自定义错误响应，用于混沌工程测试，验证微服务架构在 API 网关层的容错能力。 #### configuration 参数 - [Fault Injection](https://docs.apiseven.com/hub/fault-injection/configuration.md): 参数 ### feishu-auth feishu-auth 插件支持飞书 OAuth 2.0 身份认证，允许客户端在访问上游资源前通过飞书账号完成认证，增强 API 安全性。 - [feishu-auth 企业版](https://docs.apiseven.com/hub/feishu-auth.md): feishu-auth 插件支持飞书 OAuth 2.0 身份认证，允许客户端在访问上游资源前通过飞书账号完成认证，增强 API 安全性。 #### configuration 参数 - [Feishu Auth](https://docs.apiseven.com/hub/feishu-auth/configuration.md): 参数 ### forward-auth Forward Auth 插件将 Apache APISIX 的认证请求转发到外部认证服务，支持与任意 OAuth2、JWT 或自定义认证系统集成，实现 API 网关层的灵活外部鉴权。 - [forward-auth](https://docs.apiseven.com/hub/forward-auth.md): Forward Auth 插件将 Apache APISIX 的认证请求转发到外部认证服务，支持与任意 OAuth2、JWT 或自定义认证系统集成，实现 API 网关层的灵活外部鉴权。 #### configuration 参数 - [Forward Auth](https://docs.apiseven.com/hub/forward-auth/configuration.md): 参数 ### google-cloud-logging Google Cloud Logging 插件将 Apache APISIX 的 API 访问日志实时推送到 Google Cloud Logging，与 GCP 生态无缝集成，增强 API 网关在云原生环境下的可观测性。 - [google-cloud-logging](https://docs.apiseven.com/hub/google-cloud-logging.md): Google Cloud Logging 插件将 Apache APISIX 的 API 访问日志实时推送到 Google Cloud Logging，与 GCP 生态无缝集成，增强 API 网关在云原生环境下的可观测性。 #### configuration 参数 - [Google Cloud Logging](https://docs.apiseven.com/hub/google-cloud-logging/configuration.md): 参数 ### graphql-limit-count GraphQL Limit Count 插件针对 GraphQL API 实现请求速率限制，基于查询复杂度或请求次数控制访问频率，防止 GraphQL 接口被滥用，保障 API 网关的稳定性。 - [graphql-limit-count](https://docs.apiseven.com/hub/graphql-limit-count.md): GraphQL Limit Count 插件针对 GraphQL API 实现请求速率限制，基于查询复杂度或请求次数控制访问频率，防止 GraphQL 接口被滥用，保障 API 网关的稳定性。 #### configuration 参数 - [GraphQL Limit Count](https://docs.apiseven.com/hub/graphql-limit-count/configuration.md): 参数 ### graphql-proxy-cache GraphQL Proxy Cache 插件在 Apache APISIX 层缓存 GraphQL 查询响应，减少对后端 GraphQL 服务的重复请求，显著提升 API 响应速度，降低后端服务负载。 - [graphql-proxy-cache](https://docs.apiseven.com/hub/graphql-proxy-cache.md): GraphQL Proxy Cache 插件在 Apache APISIX 层缓存 GraphQL 查询响应，减少对后端 GraphQL 服务的重复请求，显著提升 API 响应速度，降低后端服务负载。 #### configuration 静态配置 - [GraphQL Proxy Cache](https://docs.apiseven.com/hub/graphql-proxy-cache/configuration.md): 静态配置 ### grpc-transcode gRPC Transcode 插件将 HTTP/JSON 请求转换为 gRPC 协议，让 RESTful 客户端无缝访问 gRPC 后端服务，通过 Apache APISIX 实现 REST 与 gRPC 的协议桥接。 - [grpc-transcode](https://docs.apiseven.com/hub/grpc-transcode.md): gRPC Transcode 插件将 HTTP/JSON 请求转换为 gRPC 协议，让 RESTful 客户端无缝访问 gRPC 后端服务，通过 Apache APISIX 实现 REST 与 gRPC 的协议桥接。 #### configuration 参数 - [gRPC Transcode](https://docs.apiseven.com/hub/grpc-transcode/configuration.md): 参数 ### grpc-web gRPC Web 插件使 Apache APISIX 支持 gRPC-Web 协议，让浏览器端应用能够直接调用 gRPC 后端服务，解决 Web 客户端与 gRPC 服务之间的协议兼容问题。 - [grpc-web](https://docs.apiseven.com/hub/grpc-web.md): gRPC Web 插件使 Apache APISIX 支持 gRPC-Web 协议，让浏览器端应用能够直接调用 gRPC 后端服务，解决 Web 客户端与 gRPC 服务之间的协议兼容问题。 #### configuration 参数 - [gRPC Web](https://docs.apiseven.com/hub/grpc-web/configuration.md): 参数 ### hmac-auth HMAC Auth 插件为 Apache APISIX 提供基于 HMAC 签名的 API 身份认证，通过验证请求签名确保请求完整性和来源可信，为 API 网关提供防篡改的安全认证机制。 - [hmac-auth](https://docs.apiseven.com/hub/hmac-auth.md): HMAC Auth 插件为 Apache APISIX 提供基于 HMAC 签名的 API 身份认证，通过验证请求签名确保请求完整性和来源可信，为 API 网关提供防篡改的安全认证机制。 #### configuration 参数 - [HMAC Auth](https://docs.apiseven.com/hub/hmac-auth/configuration.md): 参数 ### http-logger HTTP Logger 插件将 Apache APISIX 的 API 访问日志通过 HTTP 请求推送到任意日志收集服务，支持自定义日志格式，实现 API 网关日志的灵活对接与集中管理。 - [http-logger](https://docs.apiseven.com/hub/http-logger.md): HTTP Logger 插件将 Apache APISIX 的 API 访问日志通过 HTTP 请求推送到任意日志收集服务，支持自定义日志格式，实现 API 网关日志的灵活对接与集中管理。 #### configuration 参数 - [HTTP Logger](https://docs.apiseven.com/hub/http-logger/configuration.md): 参数 ### ip-restriction IP Restriction 插件基于客户端 IP 地址对 Apache APISIX 路由进行访问控制，支持 IP 白名单和黑名单配置，快速实现 API 网关层的网络访问限制与安全防护。 - [ip-restriction](https://docs.apiseven.com/hub/ip-restriction.md): IP Restriction 插件基于客户端 IP 地址对 Apache APISIX 路由进行访问控制，支持 IP 白名单和黑名单配置，快速实现 API 网关层的网络访问限制与安全防护。 #### configuration 参数 - [IP Restriction](https://docs.apiseven.com/hub/ip-restriction/configuration.md): 参数 ### jwe-decrypt JWE Decrypt 插件在 Apache APISIX 网关层解密 JSON Web Encryption（JWE）加密的请求数据，将明文转发给上游服务，实现端到端数据加密传输的透明解密处理。 - [jwe-decrypt](https://docs.apiseven.com/hub/jwe-decrypt.md): JWE Decrypt 插件在 Apache APISIX 网关层解密 JSON Web Encryption（JWE）加密的请求数据，将明文转发给上游服务，实现端到端数据加密传输的透明解密处理。 #### configuration 参数 - [JWE Decrypt](https://docs.apiseven.com/hub/jwe-decrypt/configuration.md): 参数 ### jwt-auth JWT Auth 插件为 Apache APISIX 提供基于 JSON Web Token 的 API 身份认证，支持 HS256、RS256 等多种签名算法，在 API 网关层实现无状态的安全身份认证。 - [jwt-auth](https://docs.apiseven.com/hub/jwt-auth.md): JWT Auth 插件为 Apache APISIX 提供基于 JSON Web Token 的 API 身份认证，支持 HS256、RS256 等多种签名算法，在 API 网关层实现无状态的安全身份认证。 #### configuration 参数 - [JWT Auth](https://docs.apiseven.com/hub/jwt-auth/configuration.md): 参数 ### kafka-logger Kafka Logger 插件将 Apache APISIX 的 API 访问日志实时推送到 Apache Kafka 消息队列，支持高吞吐量日志流处理，为 API 网关的实时日志分析提供可靠数据管道。 - [kafka-logger](https://docs.apiseven.com/hub/kafka-logger.md): Kafka Logger 插件将 Apache APISIX 的 API 访问日志实时推送到 Apache Kafka 消息队列，支持高吞吐量日志流处理，为 API 网关的实时日志分析提供可靠数据管道。 #### configuration 参数 - [Kafka Logger](https://docs.apiseven.com/hub/kafka-logger/configuration.md): 参数 ### key-auth Key Auth 插件为 Apache APISIX 提供基于 API Key 的身份认证，支持通过请求头或查询参数传递密钥，快速为 API 网关启用简单高效的 API 密钥认证保护。 - [key-auth](https://docs.apiseven.com/hub/key-auth.md): Key Auth 插件为 Apache APISIX 提供基于 API Key 的身份认证，支持通过请求头或查询参数传递密钥，快速为 API 网关启用简单高效的 API 密钥认证保护。 #### configuration 参数 - [Key Auth](https://docs.apiseven.com/hub/key-auth/configuration.md): 参数 ### ldap-auth-advanced LDAP Auth Advanced 插件对接 OpenLDAP、Active Directory 等 LDAP 目录完成客户端认证，并可把认证到的目录用户映射为消费者，使目录身份能够复用消费者级插件、限流与用量统计。 - [ldap-auth-advanced](https://docs.apiseven.com/hub/ldap-auth-advanced.md): LDAP Auth Advanced 插件对接 OpenLDAP、Active Directory 等 LDAP 目录完成客户端认证，并可把认证到的目录用户映射为消费者，使目录身份能够复用消费者级插件、限流与用量统计。 #### configuration 参数 - [LDAP Auth Advanced](https://docs.apiseven.com/hub/ldap-auth-advanced/configuration.md): 参数 ### limit-conn Limit Conn 插件基于并发连接数对 Apache APISIX 路由进行限流，防止后端服务因连接数过多而过载，保障 API 网关在高并发场景下的稳定性和服务质量。 - [limit-conn](https://docs.apiseven.com/hub/limit-conn.md): Limit Conn 插件基于并发连接数对 Apache APISIX 路由进行限流，防止后端服务因连接数过多而过载，保障 API 网关在高并发场景下的稳定性和服务质量。 #### configuration 参数 - [Limit Conn](https://docs.apiseven.com/hub/limit-conn/configuration.md): 参数 ### limit-count Limit Count 插件使用固定窗口算法对 Apache APISIX 路由进行请求速率限制，在指定时间窗口内限制请求次数，超出配额的请求将被拒绝，保护 API 网关后端服务。 - [limit-count](https://docs.apiseven.com/hub/limit-count.md): Limit Count 插件使用固定窗口算法对 Apache APISIX 路由进行请求速率限制，在指定时间窗口内限制请求次数，超出配额的请求将被拒绝，保护 API 网关后端服务。 #### configuration 参数 - [Limit Count](https://docs.apiseven.com/hub/limit-count/configuration.md): 参数 ### limit-count-advanced Limit Count Advanced 插件提供企业级 API 速率限制能力，支持多维度限流策略和共享计数器，在 Apache APISIX 网关层实现精细化的请求频率控制与流量管理。 - [limit-count-advanced 企业版](https://docs.apiseven.com/hub/limit-count-advanced.md): Limit Count Advanced 插件提供企业级 API 速率限制能力，支持多维度限流策略和共享计数器，在 Apache APISIX 网关层实现精细化的请求频率控制与流量管理。 #### configuration 参数 - [Limit Count Advanced](https://docs.apiseven.com/hub/limit-count-advanced/configuration.md): 参数 ### limit-req Limit Req 插件使用漏桶算法对 Apache APISIX 路由进行请求速率平滑限流，有效防止流量突刺对后端服务造成冲击，保障 API 网关的平稳运行和服务稳定性。 - [limit-req](https://docs.apiseven.com/hub/limit-req.md): Limit Req 插件使用漏桶算法对 Apache APISIX 路由进行请求速率平滑限流，有效防止流量突刺对后端服务造成冲击，保障 API 网关的平稳运行和服务稳定性。 #### configuration 参数 - [Limit Req](https://docs.apiseven.com/hub/limit-req/configuration.md): 参数 ### loki-logger Loki Logger 插件将 Apache APISIX 的 API 访问日志推送到 Grafana Loki，与 Grafana 生态无缝集成，实现 API 网关日志的集中存储、查询和可视化分析。 - [loki-logger](https://docs.apiseven.com/hub/loki-logger.md): Loki Logger 插件将 Apache APISIX 的 API 访问日志推送到 Grafana Loki，与 Grafana 生态无缝集成，实现 API 网关日志的集中存储、查询和可视化分析。 #### configuration 参数 - [Loki Logger](https://docs.apiseven.com/hub/loki-logger/configuration.md): 参数 ### mcp-tools-acl mcp-tools-acl 插件为 openapi-to-mcp 路由上的 MCP 工具调用提供基于消费者的访问控制，支持基于规则的白名单和黑名单模式，并可通过表达式条件进行条件匹配。 - [mcp-tools-acl 企业版](https://docs.apiseven.com/hub/mcp-tools-acl.md): mcp-tools-acl 插件为 openapi-to-mcp 路由上的 MCP 工具调用提供基于消费者的访问控制，支持基于规则的白名单和黑名单模式，并可通过表达式条件进行条件匹配。 #### configuration 参数 - [MCP Tools ACL](https://docs.apiseven.com/hub/mcp-tools-acl/configuration.md): 参数 ### mocking Mocking 插件在 Apache APISIX 网关层返回预设的模拟响应，无需启动后端服务即可进行 API 开发和测试，加速前后端并行开发，提升 API 开发效率。 - [mocking](https://docs.apiseven.com/hub/mocking.md): Mocking 插件在 Apache APISIX 网关层返回预设的模拟响应，无需启动后端服务即可进行 API 开发和测试，加速前后端并行开发，提升 API 开发效率。 #### configuration 参数 - [Mocking](https://docs.apiseven.com/hub/mocking/configuration.md): 参数 ### mqtt-proxy MQTT Proxy 插件使 Apache APISIX 支持 MQTT 协议代理，将物联网设备的 MQTT 消息路由到对应的后端 Broker，实现 API 网关对 IoT 设备的统一接入与管理。 - [mqtt-proxy](https://docs.apiseven.com/hub/mqtt-proxy.md): MQTT Proxy 插件使 Apache APISIX 支持 MQTT 协议代理，将物联网设备的 MQTT 消息路由到对应的后端 Broker，实现 API 网关对 IoT 设备的统一接入与管理。 #### configuration 参数 - [MQTT Proxy](https://docs.apiseven.com/hub/mqtt-proxy/configuration.md): 参数 ### multi-auth Multi Auth 插件允许在 Apache APISIX 路由上同时配置多种认证方式，按顺序尝试各认证插件，灵活支持多种客户端认证机制，提升 API 网关的认证兼容性。 - [multi-auth](https://docs.apiseven.com/hub/multi-auth.md): Multi Auth 插件允许在 Apache APISIX 路由上同时配置多种认证方式，按顺序尝试各认证插件，灵活支持多种客户端认证机制，提升 API 网关的认证兼容性。 #### configuration 参数 - [Multi Auth](https://docs.apiseven.com/hub/multi-auth/configuration.md): 参数 ### oas-validator OAS Validator 插件在 Apache APISIX 网关层根据 OpenAPI 规范（OAS）自动验证 API 请求和响应，确保数据符合接口契约，提升 API 质量和开发规范性。 - [oas-validator](https://docs.apiseven.com/hub/oas-validator.md): OAS Validator 插件在 Apache APISIX 网关层根据 OpenAPI 规范（OAS）自动验证 API 请求和响应，确保数据符合接口契约，提升 API 质量和开发规范性。 #### configuration 参数 - [OAS Validator](https://docs.apiseven.com/hub/oas-validator/configuration.md): 参数 ### opa OPA 插件将 Apache APISIX 与 Open Policy Agent 集成，在 API 网关层实现基于策略的细粒度授权决策，支持复杂的访问控制逻辑，满足企业级合规要求。 - [OPA](https://docs.apiseven.com/hub/opa.md): OPA 插件将 Apache APISIX 与 Open Policy Agent 集成，在 API 网关层实现基于策略的细粒度授权决策，支持复杂的访问控制逻辑，满足企业级合规要求。 #### configuration 参数 - [OPA](https://docs.apiseven.com/hub/opa/configuration.md): 参数 ### openapi-to-mcp OpenAPI to MCP 插件将 OpenAPI 规范自动转换为 MCP（Model Context Protocol）工具，使 AI Agent 能够通过 API 网关直接调用 REST API，加速 AI 应用与 API 的集成。 - [openapi-to-mcp 企业版](https://docs.apiseven.com/hub/openapi-to-mcp.md): OpenAPI to MCP 插件将 OpenAPI 规范自动转换为 MCP（Model Context Protocol）工具，使 AI Agent 能够通过 API 网关直接调用 REST API，加速 AI 应用与 API 的集成。 #### configuration 静态配置 - [OpenAPI to MCP](https://docs.apiseven.com/hub/openapi-to-mcp/configuration.md): 静态配置 ### openid-connect OpenID Connect 插件为 Apache APISIX 提供标准的 OIDC 身份认证，支持与 Keycloak、Okta、Auth0 等身份提供商集成，在 API 网关层实现企业级单点登录（SSO）。 - [openid-connect](https://docs.apiseven.com/hub/openid-connect.md): OpenID Connect 插件为 Apache APISIX 提供标准的 OIDC 身份认证，支持与 Keycloak、Okta、Auth0 等身份提供商集成，在 API 网关层实现企业级单点登录（SSO）。 #### configuration 参数 - [OpenID Connect](https://docs.apiseven.com/hub/openid-connect/configuration.md): 参数 ### opentelemetry OpenTelemetry 插件将 Apache APISIX 的请求追踪数据上报到 OpenTelemetry Collector，支持与 Jaeger、Zipkin 等后端集成，实现 API 网关的分布式追踪。 - [OpenTelemetry](https://docs.apiseven.com/hub/opentelemetry.md): OpenTelemetry 插件将 Apache APISIX 的请求追踪数据上报到 OpenTelemetry Collector，支持与 Jaeger、Zipkin 等后端集成，实现 API 网关的分布式追踪。 #### configuration 参数 - [OpenTelemetry](https://docs.apiseven.com/hub/opentelemetry/configuration.md): 参数 ### prometheus Prometheus 插件将 Apache APISIX 的 API 指标以 Prometheus 格式暴露，支持与 Grafana 集成实现可视化监控，为 API 网关提供全面的性能指标采集与告警能力。 - [Prometheus](https://docs.apiseven.com/hub/prometheus.md): Prometheus 插件将 Apache APISIX 的 API 指标以 Prometheus 格式暴露，支持与 Grafana 集成实现可视化监控，为 API 网关提供全面的性能指标采集与告警能力。 #### configuration 静态配置 - [Prometheus](https://docs.apiseven.com/hub/prometheus/configuration.md): 静态配置 ### proxy-buffering Proxy Buffering 插件控制 Apache APISIX 对上游响应的缓冲行为，支持在网关层缓存响应数据后再转发给客户端，优化大响应体的传输性能和客户端体验。 - [proxy-buffering](https://docs.apiseven.com/hub/proxy-buffering.md): Proxy Buffering 插件控制 Apache APISIX 对上游响应的缓冲行为，支持在网关层缓存响应数据后再转发给客户端，优化大响应体的传输性能和客户端体验。 #### configuration 参数 - [Proxy Buffering](https://docs.apiseven.com/hub/proxy-buffering/configuration.md): 参数 ### proxy-cache Proxy Cache 插件在 Apache APISIX 网关层缓存上游 API 响应，支持磁盘和内存两种缓存模式，显著减少后端请求压力，提升 API 响应速度和整体服务性能。 - [proxy-cache](https://docs.apiseven.com/hub/proxy-cache.md): Proxy Cache 插件在 Apache APISIX 网关层缓存上游 API 响应，支持磁盘和内存两种缓存模式，显著减少后端请求压力，提升 API 响应速度和整体服务性能。 #### configuration 静态配置 - [Proxy Cache](https://docs.apiseven.com/hub/proxy-cache/configuration.md): 静态配置 ### proxy-mirror Proxy Mirror 插件将 Apache APISIX 的 API 请求实时镜像到指定目标服务，用于流量复制、灰度测试和线上问题复现，在不影响正常流量的情况下进行 API 调试。 - [proxy-mirror](https://docs.apiseven.com/hub/proxy-mirror.md): Proxy Mirror 插件将 Apache APISIX 的 API 请求实时镜像到指定目标服务，用于流量复制、灰度测试和线上问题复现，在不影响正常流量的情况下进行 API 调试。 #### configuration 静态配置 - [Proxy Mirror](https://docs.apiseven.com/hub/proxy-mirror/configuration.md): 静态配置 ### proxy-rewrite Proxy Rewrite 插件在 Apache APISIX 转发请求前修改请求的 URI、请求头和请求方法，实现 API 网关层的路由重写与请求改造，支持灵活的 API 路由策略配置。 - [proxy-rewrite](https://docs.apiseven.com/hub/proxy-rewrite.md): Proxy Rewrite 插件在 Apache APISIX 转发请求前修改请求的 URI、请求头和请求方法，实现 API 网关层的路由重写与请求改造，支持灵活的 API 路由策略配置。 #### configuration 参数 - [Proxy Rewrite](https://docs.apiseven.com/hub/proxy-rewrite/configuration.md): 参数 ### public-api Public API 插件将 Apache APISIX 内部 API（如自定义插件接口）暴露为公开可访问的端点，支持为内部服务创建公共 API 路由，扩展 API 网关的服务暴露能力。 - [public-api](https://docs.apiseven.com/hub/public-api.md): Public API 插件将 Apache APISIX 内部 API（如自定义插件接口）暴露为公开可访问的端点，支持为内部服务创建公共 API 路由，扩展 API 网关的服务暴露能力。 #### configuration 参数 - [Public API](https://docs.apiseven.com/hub/public-api/configuration.md): 参数 ### real-ip Real IP 插件从请求头（如 X-Forwarded-For）中提取真实客户端 IP 地址，替换 Apache APISIX 获取到的代理 IP，确保 API 网关后端服务获取准确的客户端来源信息。 - [real-ip](https://docs.apiseven.com/hub/real-ip.md): Real IP 插件从请求头（如 X-Forwarded-For）中提取真实客户端 IP 地址，替换 Apache APISIX 获取到的代理 IP，确保 API 网关后端服务获取准确的客户端来源信息。 #### configuration 参数 - [Real IP](https://docs.apiseven.com/hub/real-ip/configuration.md): 参数 ### request-id Request ID 插件为每个经过 Apache APISIX 的 API 请求自动生成唯一标识符，并添加到请求头中，便于分布式系统中的请求追踪、日志关联和问题排查。 - [request-id](https://docs.apiseven.com/hub/request-id.md): Request ID 插件为每个经过 Apache APISIX 的 API 请求自动生成唯一标识符，并添加到请求头中，便于分布式系统中的请求追踪、日志关联和问题排查。 #### configuration 参数 - [Request ID](https://docs.apiseven.com/hub/request-id/configuration.md): 参数 ### request-validation Request Validation 插件在 Apache APISIX 网关层根据 JSON Schema 验证 API 请求的参数和请求体，在请求到达后端前过滤非法数据，提升 API 安全性和数据质量。 - [request-validation](https://docs.apiseven.com/hub/request-validation.md): Request Validation 插件在 Apache APISIX 网关层根据 JSON Schema 验证 API 请求的参数和请求体，在请求到达后端前过滤非法数据，提升 API 安全性和数据质量。 #### configuration 参数 - [Request Validation](https://docs.apiseven.com/hub/request-validation/configuration.md): 参数 ### response-rewrite Response Rewrite 插件在 Apache APISIX 返回响应前修改响应状态码、响应头和响应体，实现 API 网关层的响应格式统一化，无需修改后端服务即可调整 API 输出。 - [response-rewrite](https://docs.apiseven.com/hub/response-rewrite.md): Response Rewrite 插件在 Apache APISIX 返回响应前修改响应状态码、响应头和响应体，实现 API 网关层的响应格式统一化，无需修改后端服务即可调整 API 输出。 #### configuration 参数 - [Response Rewrite](https://docs.apiseven.com/hub/response-rewrite/configuration.md): 参数 ### rocketmq-logger RocketMQ Logger 插件将 Apache APISIX 的 API 访问日志实时推送到 Apache RocketMQ 消息队列，支持高吞吐量日志异步处理，为 API 网关日志分析提供可靠消息管道。 - [rocketmq-logger](https://docs.apiseven.com/hub/rocketmq-logger.md): RocketMQ Logger 插件将 Apache APISIX 的 API 访问日志实时推送到 Apache RocketMQ 消息队列，支持高吞吐量日志异步处理，为 API 网关日志分析提供可靠消息管道。 #### configuration 参数 - [RocketMQ Logger](https://docs.apiseven.com/hub/rocketmq-logger/configuration.md): 参数 ### saml-auth SAML Auth 插件为 Apache APISIX 提供基于 SAML 2.0 协议的身份认证，支持与企业 IdP（身份提供商）集成，在 API 网关层实现企业级联合身份认证与单点登录。 - [saml-auth](https://docs.apiseven.com/hub/saml-auth.md): SAML Auth 插件为 Apache APISIX 提供基于 SAML 2.0 协议的身份认证，支持与企业 IdP（身份提供商）集成，在 API 网关层实现企业级联合身份认证与单点登录。 #### configuration 参数 - [SAML Auth](https://docs.apiseven.com/hub/saml-auth/configuration.md): 参数 ### serverless-functions Serverless Functions 插件允许在 Apache APISIX 的请求处理阶段动态执行自定义 Lua 函数，无需重启网关即可扩展 API 网关功能，实现灵活的 Serverless 逻辑处理。 - [Serverless Functions](https://docs.apiseven.com/hub/serverless-functions.md): Serverless Functions 插件允许在 Apache APISIX 的请求处理阶段动态执行自定义 Lua 函数，无需重启网关即可扩展 API 网关功能，实现灵活的 Serverless 逻辑处理。 #### configuration 参数 - [Serverless Functions](https://docs.apiseven.com/hub/serverless-functions/configuration.md): 参数 ### skywalking SkyWalking 插件将 Apache APISIX 的分布式追踪数据上报到 Apache SkyWalking，实现 API 网关与微服务全链路追踪，帮助团队快速定位性能瓶颈和故障根因。 - [SkyWalking](https://docs.apiseven.com/hub/skywalking.md): SkyWalking 插件将 Apache APISIX 的分布式追踪数据上报到 Apache SkyWalking，实现 API 网关与微服务全链路追踪，帮助团队快速定位性能瓶颈和故障根因。 #### configuration 静态配置 - [skywalking](https://docs.apiseven.com/hub/skywalking/configuration.md): 静态配置 ### skywalking-logger SkyWalking Logger 插件将 Apache APISIX 的 API 访问日志推送到 Apache SkyWalking 日志收集服务，与 SkyWalking 可观测性平台深度集成，增强 API 网关的日志分析能力。 - [skywalking-logger](https://docs.apiseven.com/hub/skywalking-logger.md): SkyWalking Logger 插件将 Apache APISIX 的 API 访问日志推送到 Apache SkyWalking 日志收集服务，与 SkyWalking 可观测性平台深度集成，增强 API 网关的日志分析能力。 #### configuration 参数 - [SkyWalking Logger](https://docs.apiseven.com/hub/skywalking-logger/configuration.md): 参数 ### soap SOAP 插件使 Apache APISIX 支持将 RESTful 请求转换为 SOAP 协议请求，让现代 API 客户端无缝访问传统 SOAP Web 服务，通过 API 网关实现新旧系统的协议桥接。 - [soap 企业版](https://docs.apiseven.com/hub/soap.md): SOAP 插件使 Apache APISIX 支持将 RESTful 请求转换为 SOAP 协议请求，让现代 API 客户端无缝访问传统 SOAP Web 服务，通过 API 网关实现新旧系统的协议桥接。 #### configuration 静态配置 - [SOAP](https://docs.apiseven.com/hub/soap/configuration.md): 静态配置 ### splunk-hec-logging Splunk HEC Logging 插件通过 HTTP Event Collector（HEC）将 Apache APISIX 的 API 访问日志实时推送到 Splunk，与 Splunk 安全分析平台集成，增强 API 网关的安全监控能力。 - [splunk-hec-logging](https://docs.apiseven.com/hub/splunk-hec-logging.md): Splunk HEC Logging 插件通过 HTTP Event Collector（HEC）将 Apache APISIX 的 API 访问日志实时推送到 Splunk，与 Splunk 安全分析平台集成，增强 API 网关的安全监控能力。 #### configuration 参数 - [splunk-hec-logging](https://docs.apiseven.com/hub/splunk-hec-logging/configuration.md): 参数 ### syslog Syslog 插件将 Apache APISIX 的 API 访问日志通过标准 Syslog 协议推送到远程日志服务器，支持 UDP 和 TCP 传输，实现 API 网关日志与企业日志基础设施的无缝集成。 - [syslog](https://docs.apiseven.com/hub/syslog.md): Syslog 插件将 Apache APISIX 的 API 访问日志通过标准 Syslog 协议推送到远程日志服务器，支持 UDP 和 TCP 传输，实现 API 网关日志与企业日志基础设施的无缝集成。 #### configuration 参数 - [syslog](https://docs.apiseven.com/hub/syslog/configuration.md): 参数 ### traffic-label Traffic Label 插件根据请求属性为流经 Apache APISIX 的 API 请求打标签，支持基于标签的流量路由和策略匹配，实现精细化的 API 网关流量分类与管理。 - [traffic-label](https://docs.apiseven.com/hub/traffic-label.md): Traffic Label 插件根据请求属性为流经 Apache APISIX 的 API 请求打标签，支持基于标签的流量路由和策略匹配，实现精细化的 API 网关流量分类与管理。 #### configuration 参数 - [Traffic Label](https://docs.apiseven.com/hub/traffic-label/configuration.md): 参数 ### traffic-split Traffic Split 插件在 Apache APISIX 中实现按比例的流量分割，支持灰度发布、蓝绿部署和 A/B 测试，通过 API 网关层的流量控制降低新版本发布风险。 - [traffic-split](https://docs.apiseven.com/hub/traffic-split.md): Traffic Split 插件在 Apache APISIX 中实现按比例的流量分割，支持灰度发布、蓝绿部署和 A/B 测试，通过 API 网关层的流量控制降低新版本发布风险。 #### configuration 参数 - [Traffic Split](https://docs.apiseven.com/hub/traffic-split/configuration.md): 参数 ### ua-restriction UA Restriction 插件基于 User-Agent 请求头对 Apache APISIX 路由进行访问控制，支持白名单和黑名单配置，有效阻止爬虫或未授权客户端访问 API 网关资源。 - [ua-restriction](https://docs.apiseven.com/hub/ua-restriction.md): UA Restriction 插件基于 User-Agent 请求头对 Apache APISIX 路由进行访问控制，支持白名单和黑名单配置，有效阻止爬虫或未授权客户端访问 API 网关资源。 #### configuration 参数 - [UA Restriction](https://docs.apiseven.com/hub/ua-restriction/configuration.md): 参数 ### workflow Workflow 插件允许在 Apache APISIX 中定义多步骤的请求处理工作流，支持条件判断和动作编排，实现复杂的 API 网关流量治理逻辑，无需编写自定义插件代码。 - [workflow](https://docs.apiseven.com/hub/workflow.md): Workflow 插件允许在 Apache APISIX 中定义多步骤的请求处理工作流，支持条件判断和动作编排，实现复杂的 API 网关流量治理逻辑，无需编写自定义插件代码。 #### configuration 参数 - [Workflow](https://docs.apiseven.com/hub/workflow/configuration.md): 参数 ### zipkin Zipkin 插件将 Apache APISIX 的分布式追踪数据上报到 Zipkin，支持与 Zipkin 兼容的追踪后端集成，为 API 网关提供请求链路追踪能力，助力微服务性能分析。 - [zipkin](https://docs.apiseven.com/hub/zipkin.md): Zipkin 插件将 Apache APISIX 的分布式追踪数据上报到 Zipkin，支持与 Zipkin 兼容的追踪后端集成，为 API 网关提供请求链路追踪能力，助力微服务性能分析。 #### configuration 静态配置 - [Zipkin](https://docs.apiseven.com/hub/zipkin/configuration.md): 静态配置 ## ai-gateway 通过专门的网关层路由 AI 请求，集中管理服务提供方密钥、模型别名、路由和流量策略。 - [AISIX AI 网关](https://docs.apiseven.com/ai-gateway.md): 通过专门的网关层路由 AI 请求，集中管理服务提供方密钥、模型别名、路由和流量策略。 ### agent-gateway #### agent-access-control 在 AISIX AI 网关中，通过精确 Agent 名称或通配符限制每个调用方 API Key 可访问的 A2A Agent；默认拒绝访问。 - [按 Key 控制 Agent 访问](https://docs.apiseven.com/ai-gateway/agent-gateway/agent-access-control.md): 在 AISIX AI 网关中，通过精确 Agent 名称或通配符限制每个调用方 API Key 可访问的 A2A Agent；默认拒绝访问。 #### observability 查看 AISIX AI 网关中 A2A Agent 调用产生的用量事件和 Prometheus 指标，并通过协议标签将 A2A 流量与模型流量区分开。 - [可观测性](https://docs.apiseven.com/ai-gateway/agent-gateway/observability.md): 查看 AISIX AI 网关中 A2A Agent 调用产生的用量事件和 Prometheus 指标，并通过协议标签将 A2A 流量与模型流量区分开。 #### overview 通过 AISIX AI 网关暴露上游 A2A（Agent-to-Agent）Agent，并统一管理调用方 API Key 访问控制、上游认证、限流、预算和遥测。 - [Agent 网关概览](https://docs.apiseven.com/ai-gateway/agent-gateway/overview.md): 通过 AISIX AI 网关暴露上游 A2A（Agent-to-Agent）Agent，并统一管理调用方 API Key 访问控制、上游认证、限流、预算和遥测。 #### traffic-controls 在 AISIX AI 网关中，将调用方 API Key 的限流和预算能力应用到 A2A Agent 调用，并与模型流量共用同一套治理边界。 - [限流与预算](https://docs.apiseven.com/ai-gateway/agent-gateway/traffic-controls.md): 在 AISIX AI 网关中，将调用方 API Key 的限流和预算能力应用到 A2A Agent 调用，并与模型流量共用同一套治理边界。 #### upstream-authentication 配置 AISIX AI 网关如何认证到每个上游 A2A Agent，包括无凭证、Bearer Token 和 API Key；凭证保留在网关侧，不会暴露给调用方。 - [上游认证](https://docs.apiseven.com/ai-gateway/agent-gateway/upstream-authentication.md): 配置 AISIX AI 网关如何认证到每个上游 A2A Agent，包括无凭证、Bearer Token 和 API Key；凭证保留在网关侧，不会暴露给调用方。 ### cloud #### admin-tokens 创建和管理用于组织级自动化的 AISIX Cloud Admin Token，包括权限范围、过期、轮换、吊销和 SCIM 访问。 - [Admin Token](https://docs.apiseven.com/ai-gateway/cloud/admin-tokens.md): 创建和管理用于组织级自动化的 AISIX Cloud Admin Token，包括权限范围、过期、轮换、吊销和 SCIM 访问。 #### connect-a-gateway 使用控制台签发的 mTLS 凭证、部署片段和连接验证，将 AISIX 网关作为 AISIX Cloud 环境的数据面接入。 - [连接 AISIX 网关](https://docs.apiseven.com/ai-gateway/cloud/connect-a-gateway.md): 使用控制台签发的 mTLS 凭证、部署片段和连接验证，将 AISIX 网关作为 AISIX Cloud 环境的数据面接入。 #### custom-roles 了解内置的 owner、admin 和 member 角色，并在 AISIX Cloud 控制面中定义具有细粒度读写权限的组织级自定义角色。 - [角色与自定义角色](https://docs.apiseven.com/ai-gateway/cloud/custom-roles.md): 了解内置的 owner、admin 和 member 角色，并在 AISIX Cloud 控制面中定义具有细粒度读写权限的组织级自定义角色。 #### high-availability 使用冗余 AISIX 网关、高韧性的控制面连接和上游故障转移，设计高可用的 AISIX Cloud 流量路径。 - [高可用](https://docs.apiseven.com/ai-gateway/cloud/high-availability.md): 使用冗余 AISIX 网关、高韧性的控制面连接和上游故障转移，设计高可用的 AISIX Cloud 流量路径。 #### kubernetes 使用 api7/aisix Helm Chart、HorizontalPodAutoscaler 或 KEDA，在 Kubernetes 上部署和扩缩作为 AISIX Cloud 数据面的 AISIX 网关。 - [在 Kubernetes 上部署 AISIX 网关](https://docs.apiseven.com/ai-gateway/cloud/kubernetes.md): 使用 api7/aisix Helm Chart、HorizontalPodAutoscaler 或 KEDA，在 Kubernetes 上部署和扩缩作为 AISIX Cloud 数据面的 AISIX 网关。 #### logging-and-auditing 了解 AISIX Cloud 控制面如何记录网关请求和资源变更。 - [日志与审计](https://docs.apiseven.com/ai-gateway/cloud/logging-and-auditing.md): 了解 AISIX Cloud 控制面如何记录网关请求和资源变更。 #### members 为 AISIX Cloud 控制面访问或 API Key 归属添加组织成员。 - [成员](https://docs.apiseven.com/ai-gateway/cloud/members.md): 为 AISIX Cloud 控制面访问或 API Key 归属添加组织成员。 #### model-pricing 了解 AISIX Cloud 控制面如何计算每个请求的成本，以及如何为目录未覆盖的模型设置价格。 - [模型定价](https://docs.apiseven.com/ai-gateway/cloud/model-pricing.md): 了解 AISIX Cloud 控制面如何计算每个请求的成本，以及如何为目录未覆盖的模型设置价格。 #### offline-resilience 了解 AISIX 网关在临时失去控制面连接时的行为。 - [离线韧性](https://docs.apiseven.com/ai-gateway/cloud/offline-resilience.md): 了解 AISIX 网关在临时失去控制面连接时的行为。 #### organizations-and-environments 创建和了解 AISIX Cloud 组织与环境，以及环境资源如何到达已连接的 AISIX 网关。 - [组织与环境](https://docs.apiseven.com/ai-gateway/cloud/organizations-and-environments.md): 创建和了解 AISIX Cloud 组织与环境，以及环境资源如何到达已连接的 AISIX 网关。 #### overview 了解 AISIX Cloud 如何提供集中管理能力，同时由你的环境中的 AISIX 网关直接处理 AI 流量。 - [AISIX Cloud](https://docs.apiseven.com/ai-gateway/cloud/overview.md): 了解 AISIX Cloud 如何提供集中管理能力，同时由你的环境中的 AISIX 网关直接处理 AI 流量。 #### playground 了解 AISIX Cloud Playground 请求与网关请求分别可以验证哪些内容。 - [Playground](https://docs.apiseven.com/ai-gateway/cloud/playground.md): 了解 AISIX Cloud Playground 请求与网关请求分别可以验证哪些内容。 #### resource-projection 了解 AISIX Cloud 如何投射环境资源，以及如何验证发布、网关应用和调用方可见行为。 - [资源投射](https://docs.apiseven.com/ai-gateway/cloud/resource-projection.md): 了解 AISIX Cloud 如何投射环境资源，以及如何验证发布、网关应用和调用方可见行为。 #### scim-directory-sync 使用 SCIM 2.0 从身份提供方自动预配 AISIX 组织成员。 - [SCIM 目录同步](https://docs.apiseven.com/ai-gateway/cloud/scim-directory-sync.md): 使用 SCIM 2.0 从身份提供方自动预配 AISIX 组织成员。 #### usage-reporting 了解 AISIX Cloud 控制面如何上报网关用量、支出和预算相关信号。 - [用量上报](https://docs.apiseven.com/ai-gateway/cloud/usage-reporting.md): 了解 AISIX Cloud 控制面如何上报网关用量、支出和预算相关信号。 ### deployment #### configuration-propagation 了解资源变更如何到达 AISIX 网关、安全地重新加载声明式资源文件，并验证已应用的配置。 - [配置传播](https://docs.apiseven.com/ai-gateway/deployment/configuration-propagation.md): 了解资源变更如何到达 AISIX 网关、安全地重新加载声明式资源文件，并验证已应用的配置。 #### health-checks 选择并解读 AISIX 网关的进程存活、流量就绪、模型健康和配置状态检查。 - [健康检查](https://docs.apiseven.com/ai-gateway/deployment/health-checks.md): 选择并解读 AISIX 网关的进程存活、流量就绪、模型健康和配置状态检查。 #### network-and-security 使用正确的监听器暴露、配置来源隔离和凭证处理方式运行 AISIX AI 网关。 - [网络与安全](https://docs.apiseven.com/ai-gateway/deployment/network-and-security.md): 使用正确的监听器暴露、配置来源隔离和凭证处理方式运行 AISIX AI 网关。 #### performance-and-sizing 了解 AISIX AI 网关的预期代理开销和吞吐能力，并根据请求量估算所需 CPU。 - [性能与容量规划](https://docs.apiseven.com/ai-gateway/deployment/performance-and-sizing.md): 了解 AISIX AI 网关的预期代理开销和吞吐能力，并根据请求量估算所需 CPU。 #### production 通过规划容量、依赖、网络暴露、健康检查、恢复和关闭，为 AISIX AI 网关接入生产流量做好准备。 - [生产就绪](https://docs.apiseven.com/ai-gateway/deployment/production.md): 通过规划容量、依赖、网络暴露、健康检查、恢复和关闭，为 AISIX AI 网关接入生产流量做好准备。 #### startup-configuration 配置 AISIX AI 网关启动设置，包括资源来源、监听器、运行时依赖、可观测性和 AISIX Cloud 连接。 - [启动配置](https://docs.apiseven.com/ai-gateway/deployment/startup-configuration.md): 配置 AISIX AI 网关启动设置，包括资源来源、监听器、运行时依赖、可观测性和 AISIX Cloud 连接。 #### thread-per-core-workers 配置 AISIX AI 网关的 Worker 线程和每核一线程服务模式，验证当前模式，并规划各 Worker 独立的上游连接池与共享监听器。 - [每核一线程 Worker](https://docs.apiseven.com/ai-gateway/deployment/thread-per-core-workers.md): 配置 AISIX AI 网关的 Worker 线程和每核一线程服务模式，验证当前模式，并规划各 Worker 独立的上游连接池与共享监听器。 #### tls-and-mtls 为 AISIX AI 网关配置监听器 TLS、上游信任、etcd mTLS 和 AISIX Cloud 控制面 mTLS。 - [TLS 与 mTLS](https://docs.apiseven.com/ai-gateway/deployment/tls-and-mtls.md): 为 AISIX AI 网关配置监听器 TLS、上游信任、etcd mTLS 和 AISIX Cloud 控制面 mTLS。 #### troubleshooting 诊断 AISIX AI 网关的启动、配置、调用方访问、策略、上游和 AISIX 网关故障。 - [故障排除](https://docs.apiseven.com/ai-gateway/deployment/troubleshooting.md): 诊断 AISIX AI 网关的启动、配置、调用方访问、策略、上游和 AISIX 网关故障。 #### url-rewriting 使用入口级重写规则将旧版或外部 URL 形式映射到 AISIX AI 网关端点，使现有客户端无需更改配置即可迁移。 - [URL 重写](https://docs.apiseven.com/ai-gateway/deployment/url-rewriting.md): 使用入口级重写规则将旧版或外部 URL 形式映射到 AISIX AI 网关端点，使现有客户端无需更改配置即可迁移。 ### endpoints #### anthropic-messages 了解 AISIX AI 网关如何处理 Anthropic 风格 Messages 请求，包括调用方密钥、模型别名、上游转换、Token 计数和错误处理。 - [Anthropic 风格 Messages API](https://docs.apiseven.com/ai-gateway/endpoints/anthropic-messages.md): 了解 AISIX AI 网关如何处理 Anthropic 风格 Messages 请求，包括调用方密钥、模型别名、上游转换、Token 计数和错误处理。 #### audio 了解 AISIX AI 网关如何处理 OpenAI 风格的音频转录、翻译和语音端点。 - [语音与音频](https://docs.apiseven.com/ai-gateway/endpoints/audio.md): 了解 AISIX AI 网关如何处理 OpenAI 风格的音频转录、翻译和语音端点。 #### batch-files-fine-tuning 通过 AISIX AI 网关运行兼容 OpenAI 的 Files、Batch 和 Fine-tuning API，由网关管理服务提供方路由和批处理用量归因。 - [Batch、Files 与 Fine-tuning](https://docs.apiseven.com/ai-gateway/endpoints/batch-files-fine-tuning.md): 通过 AISIX AI 网关运行兼容 OpenAI 的 Files、Batch 和 Fine-tuning API，由网关管理服务提供方路由和批处理用量归因。 #### embeddings 了解 AISIX AI 网关如何处理 OpenAI 兼容的 embeddings 端点，包括请求格式和服务提供方限制。 - [向量嵌入](https://docs.apiseven.com/ai-gateway/endpoints/embeddings.md): 了解 AISIX AI 网关如何处理 OpenAI 兼容的 embeddings 端点，包括请求格式和服务提供方限制。 #### image-generation 了解 AISIX AI 网关如何处理 OpenAI 图像生成端点及服务提供方支持情况。 - [图像生成](https://docs.apiseven.com/ai-gateway/endpoints/image-generation.md): 了解 AISIX AI 网关如何处理 OpenAI 图像生成端点及服务提供方支持情况。 #### openai-client-to-anthropic 使用兼容 OpenAI 的客户端调用由 Anthropic 支持的 AISIX 模型别名，并了解网关如何转换请求和响应。 - [OpenAI 客户端接入 Anthropic 上游](https://docs.apiseven.com/ai-gateway/endpoints/openai-client-to-anthropic.md): 使用兼容 OpenAI 的客户端调用由 Anthropic 支持的 AISIX 模型别名，并了解网关如何转换请求和响应。 #### openai-compatible-chat 了解 AISIX AI 网关如何处理兼容 OpenAI 的请求，包括调用方密钥、模型别名、路由支持和错误处理。 - [兼容 OpenAI 的 API](https://docs.apiseven.com/ai-gateway/endpoints/openai-compatible-chat.md): 了解 AISIX AI 网关如何处理兼容 OpenAI 的请求，包括调用方密钥、模型别名、路由支持和错误处理。 #### overview 查看 AISIX 在代理监听器上公开的面向调用方端点系列。 - [支持的端点](https://docs.apiseven.com/ai-gateway/endpoints/overview.md): 查看 AISIX 在代理监听器上公开的面向调用方端点系列。 #### provider-passthrough 通过 AISIX AI 网关转发服务提供方原生请求而不转换端点，并了解标识符、凭证、限制和错误。 - [服务提供方透传](https://docs.apiseven.com/ai-gateway/endpoints/provider-passthrough.md): 通过 AISIX AI 网关转发服务提供方原生请求而不转换端点，并了解标识符、凭证、限制和错误。 #### realtime 通过 AISIX AI 网关连接 OpenAI Realtime WebSocket 客户端，由网关管理认证、策略执行和会话用量跟踪。 - [Realtime API](https://docs.apiseven.com/ai-gateway/endpoints/realtime.md): 通过 AISIX AI 网关连接 OpenAI Realtime WebSocket 客户端，由网关管理认证、策略执行和会话用量跟踪。 #### request-lifecycle 了解 AISIX 如何认证调用方、解析模型别名、应用控制策略、路由到服务提供方并记录每个 AI 请求的用量。 - [请求生命周期](https://docs.apiseven.com/ai-gateway/endpoints/request-lifecycle.md): 了解 AISIX 如何认证调用方、解析模型别名、应用控制策略、路由到服务提供方并记录每个 AI 请求的用量。 #### rerank 了解 AISIX AI 网关如何通过支持重排序能力的服务提供方代理 rerank 请求。 - [重排序](https://docs.apiseven.com/ai-gateway/endpoints/rerank.md): 了解 AISIX AI 网关如何通过支持重排序能力的服务提供方代理 rerank 请求。 #### responses-api 了解 AISIX AI 网关如何处理 OpenAI Responses API 及服务提供方支持情况。 - [Responses API 代理](https://docs.apiseven.com/ai-gateway/endpoints/responses-api.md): 了解 AISIX AI 网关如何处理 OpenAI Responses API 及服务提供方支持情况。 #### streaming 了解 AISIX AI 网关的流式响应行为，包括 OpenAI 风格和 Anthropic 风格流式链路。 - [流式响应](https://docs.apiseven.com/ai-gateway/endpoints/streaming.md): 了解 AISIX AI 网关的流式响应行为，包括 OpenAI 风格和 Anthropic 风格流式链路。 #### text-completions 了解 AISIX AI 网关如何处理兼容 OpenAI 的文本补全请求。 - [文本补全](https://docs.apiseven.com/ai-gateway/endpoints/text-completions.md): 了解 AISIX AI 网关如何处理兼容 OpenAI 的文本补全请求。 #### tool-calling 了解 AISIX AI 网关中的工具调用行为，包括兼容 OpenAI 的请求和 Anthropic 转换。 - [工具调用](https://docs.apiseven.com/ai-gateway/endpoints/tool-calling.md): 了解 AISIX AI 网关中的工具调用行为，包括兼容 OpenAI 的请求和 Anthropic 转换。 #### video-generation 通过 AISIX AI 网关的 /v1/videos 端点异步提交任务、轮询状态并下载视频。 - [视频生成](https://docs.apiseven.com/ai-gateway/endpoints/video-generation.md): 通过 AISIX AI 网关的 /v1/videos 端点异步提交任务、轮询状态并下载视频。 ### getting-started #### aisix-cloud-quickstart 使用 Docker Compose 部署 AISIX Cloud 控制面、配置模型，并通过已连接的 AISIX 网关发送第一个请求。 - [AISIX Cloud 快速入门](https://docs.apiseven.com/ai-gateway/getting-started/aisix-cloud-quickstart.md): 使用 Docker Compose 部署 AISIX Cloud 控制面、配置模型，并通过已连接的 AISIX 网关发送第一个请求。 #### anthropic-sdk 配置兼容 Anthropic 的客户端，通过 /v1/messages 代理 API 调用 AISIX AI 网关。 - [Anthropic SDK](https://docs.apiseven.com/ai-gateway/getting-started/anthropic-sdk.md): 配置兼容 Anthropic 的客户端，通过 /v1/messages 代理 API 调用 AISIX AI 网关。 #### gateway-quickstart 在单个容器中运行开源 AISIX 网关，在 resources.yaml 文件中声明模型服务提供方密钥、模型和调用方 API Key，并发送第一个请求。 - [开源 AISIX 网关快速入门](https://docs.apiseven.com/ai-gateway/getting-started/gateway-quickstart.md): 在单个容器中运行开源 AISIX 网关，在 resources.yaml 文件中声明模型服务提供方密钥、模型和调用方 API Key，并发送第一个请求。 #### openai-sdk 配置 OpenAI 官方 SDK，通过兼容 OpenAI 的代理 API 调用 AISIX AI 网关。 - [OpenAI SDK](https://docs.apiseven.com/ai-gateway/getting-started/openai-sdk.md): 配置 OpenAI 官方 SDK，通过兼容 OpenAI 的代理 API 调用 AISIX AI 网关。 #### products-and-deployment-options 对比开源 AISIX 网关与 AISIX Cloud 的 On-Premises 和 Hybrid Cloud 控制面部署选项。 - [AISIX 产品与部署选项](https://docs.apiseven.com/ai-gateway/getting-started/products-and-deployment-options.md): 对比开源 AISIX 网关与 AISIX Cloud 的 On-Premises 和 Hybrid Cloud 控制面部署选项。 ### integrations 将编码 Agent、应用框架和 AI 库接入 AISIX AI 网关。 - [集成](https://docs.apiseven.com/ai-gateway/integrations.md): 将编码 Agent、应用框架和 AI 库接入 AISIX AI 网关。 #### coding-agents 将编码 Agent 和 AI 编码工具接入 AISIX AI 网关，以统一治理模型和工具流量。 - [编码 Agent](https://docs.apiseven.com/ai-gateway/integrations/coding-agents.md): 将编码 Agent 和 AI 编码工具接入 AISIX AI 网关，以统一治理模型和工具流量。 - [Claude Code](https://docs.apiseven.com/ai-gateway/integrations/coding-agents/claude-code.md): 配置 Claude Code 通过 AISIX AI 网关发送 Anthropic Messages 请求。 - [Cline](https://docs.apiseven.com/ai-gateway/integrations/coding-agents/cline.md): 配置 Cline 通过 AISIX AI 网关发送兼容 OpenAI 的模型请求。 - [Codex](https://docs.apiseven.com/ai-gateway/integrations/coding-agents/codex.md): 配置 Codex 通过 AISIX AI 网关发送 Responses API 请求。 - [Cursor](https://docs.apiseven.com/ai-gateway/integrations/coding-agents/cursor.md): 配置 Cursor 通过 AISIX AI 网关发送兼容 OpenAI 的聊天流量。 #### frameworks - [CrewAI](https://docs.apiseven.com/ai-gateway/integrations/frameworks/crewai.md): 配置 CrewAI 通过 AISIX AI 网关发送兼容 OpenAI 的聊天流量。 - [Haystack](https://docs.apiseven.com/ai-gateway/integrations/frameworks/haystack.md): 配置 Haystack 通过 AISIX AI 网关发送 OpenAI Responses API 流量。 - [Instructor](https://docs.apiseven.com/ai-gateway/integrations/frameworks/instructor.md): 配置 Instructor 通过 AISIX AI 网关发送 OpenAI Responses API 结构化输出请求。 - [LangChain 和 LangGraph](https://docs.apiseven.com/ai-gateway/integrations/frameworks/langchain.md): 配置 LangChain 和 LangGraph 通过 AISIX AI 网关发送 OpenAI Responses API 流量。 - [LlamaIndex](https://docs.apiseven.com/ai-gateway/integrations/frameworks/llamaindex.md): 配置 LlamaIndex 通过 AISIX AI 网关发送 OpenAI Responses API 流量。 - [Microsoft Agent Framework](https://docs.apiseven.com/ai-gateway/integrations/frameworks/microsoft-agent-framework.md): 配置 Microsoft Agent Framework 通过 AISIX AI 网关发送 OpenAI Responses API 流量。 - [OpenAI Agents SDK](https://docs.apiseven.com/ai-gateway/integrations/frameworks/openai-agents-sdk.md): 配置 OpenAI Agents SDK 通过 AISIX AI 网关发送 OpenAI Responses API 流量。 - [Pydantic AI](https://docs.apiseven.com/ai-gateway/integrations/frameworks/pydantic-ai.md): 配置 Pydantic AI 通过 AISIX AI 网关发送 OpenAI Responses API 流量。 - [Vercel AI SDK](https://docs.apiseven.com/ai-gateway/integrations/frameworks/vercel-ai-sdk.md): 配置 Vercel AI SDK 通过 AISIX AI 网关发送 OpenAI Responses API 流量。 ### mcp-gateway #### access-policies 跨 AISIX Cloud 环境和团队管理 MCP 工具访问权限，并让调用方 API Key 继承、收窄或拒绝共享策略授权。 - [使用策略管理 MCP 访问权限](https://docs.apiseven.com/ai-gateway/mcp-gateway/access-policies.md): 跨 AISIX Cloud 环境和团队管理 MCP 工具访问权限，并让调用方 API Key 继承、收窄或拒绝共享策略授权。 #### guardrails 在 AISIX AI 网关中，对 MCP 工具调用参数和工具结果应用与模型流量相同的安全护栏，并在请求到达上游前阻断风险调用。 - [安全护栏](https://docs.apiseven.com/ai-gateway/mcp-gateway/guardrails.md): 在 AISIX AI 网关中，对 MCP 工具调用参数和工具结果应用与模型流量相同的安全护栏，并在请求到达上游前阻断风险调用。 #### observability 查看 AISIX AI 网关中 MCP 工具调用产生的用量事件和 Prometheus 指标，并通过协议标签将 MCP 流量与模型流量区分开。 - [可观测性](https://docs.apiseven.com/ai-gateway/mcp-gateway/observability.md): 查看 AISIX AI 网关中 MCP 工具调用产生的用量事件和 Prometheus 指标，并通过协议标签将 MCP 流量与模型流量区分开。 #### openapi-servers 使用 REST API 的 OpenAPI 文档注册该 API，让 AISIX AI 网关从其操作生成 MCP 工具，并把工具调用作为 HTTP 请求执行。 - [把 REST API 公开为 MCP 工具](https://docs.apiseven.com/ai-gateway/mcp-gateway/openapi-servers.md): 使用 REST API 的 OpenAPI 文档注册该 API，让 AISIX AI 网关从其操作生成 MCP 工具，并把工具调用作为 HTTP 请求执行。 #### overview 通过 AISIX AI 网关公开上游 MCP 服务器，并应用调用方 API Key 访问控制、上游身份认证、安全护栏和遥测。 - [MCP 网关概览](https://docs.apiseven.com/ai-gateway/mcp-gateway/overview.md): 通过 AISIX AI 网关公开上游 MCP 服务器，并应用调用方 API Key 访问控制、上游身份认证、安全护栏和遥测。 #### server-review 在把 MCP 服务器注册和变更发布到网关前，通过 AISIX Cloud 进行审查，并撤销不再成立的批准。 - [审查并批准 MCP 服务器](https://docs.apiseven.com/ai-gateway/mcp-gateway/server-review.md): 在把 MCP 服务器注册和变更发布到网关前，通过 AISIX Cloud 进行审查，并撤销不再成立的批准。 #### setup 在 AISIX Cloud 或开源 AISIX 网关中注册上游 MCP 服务器，授权一个工具，并验证允许和拒绝的 MCP 调用。 - [设置 MCP 网关](https://docs.apiseven.com/ai-gateway/mcp-gateway/setup.md): 在 AISIX Cloud 或开源 AISIX 网关中注册上游 MCP 服务器，授权一个工具，并验证允许和拒绝的 MCP 调用。 #### tool-access-control 使用精确名称、按服务器通配符或全局通配符，把每把调用方 API Key 限定为可在 AISIX AI 网关中列出和调用的 MCP 工具。 - [控制 MCP 工具访问](https://docs.apiseven.com/ai-gateway/mcp-gateway/tool-access-control.md): 使用精确名称、按服务器通配符或全局通配符，把每把调用方 API Key 限定为可在 AISIX AI 网关中列出和调用的 MCP 工具。 #### traffic-controls 以调用方 API Key 为边界，在 AISIX AI 网关中配置 MCP 请求和并发限制，以及 AISIX Cloud 预算。 - [限流和预算](https://docs.apiseven.com/ai-gateway/mcp-gateway/traffic-controls.md): 以调用方 API Key 为边界，在 AISIX AI 网关中配置 MCP 请求和并发限制，以及 AISIX Cloud 预算。 #### upstream-authentication 配置 AISIX AI 网关如何通过无凭证、Bearer Token、API Key 或 OAuth 2.0 客户端凭证向每个上游 MCP 服务器执行身份认证。 - [上游身份认证](https://docs.apiseven.com/ai-gateway/mcp-gateway/upstream-authentication.md): 配置 AISIX AI 网关如何通过无凭证、Bearer Token、API Key 或 OAuth 2.0 客户端凭证向每个上游 MCP 服务器执行身份认证。 ### models #### model-aliases 在 AISIX 网关部署中配置直接模型别名和通配符模型别名，包括重试、定价、限流及其他模型级行为。 - [模型别名](https://docs.apiseven.com/ai-gateway/models/model-aliases.md): 在 AISIX 网关部署中配置直接模型别名和通配符模型别名，包括重试、定价、限流及其他模型级行为。 #### provider-key-rotation 通过原地轮换和渐进迁移流程，在不同 AISIX 网关部署中轮换上游服务提供方凭证，同时保持调用方 API Key 和模型别名稳定。 - [服务提供方密钥轮换](https://docs.apiseven.com/ai-gateway/models/provider-key-rotation.md): 通过原地轮换和渐进迁移流程，在不同 AISIX 网关部署中轮换上游服务提供方凭证，同时保持调用方 API Key 和模型别名稳定。 #### provider-keys 在不同 AISIX 网关部署中配置服务提供方密钥，包括上游凭证、端点、适配器、请求头、兼容性覆盖和轮换。 - [服务提供方密钥](https://docs.apiseven.com/ai-gateway/models/provider-keys.md): 在不同 AISIX 网关部署中配置服务提供方密钥，包括上游凭证、端点、适配器、请求头、兼容性覆盖和轮换。 #### resource-model 了解服务提供方密钥、模型、调用方 API Key、路由、流量控制和策略如何在不同 AISIX 网关部署中协同工作。 - [资源模型](https://docs.apiseven.com/ai-gateway/models/resource-model.md): 了解服务提供方密钥、模型、调用方 API Key、路由、流量控制和策略如何在不同 AISIX 网关部署中协同工作。 #### upstream-request-headers 配置 AISIX 网关注入请求上下文请求头，并把允许的客户端请求头转发给 AI 服务提供方，同时保护保留请求头。 - [上游请求头](https://docs.apiseven.com/ai-gateway/models/upstream-request-headers.md): 配置 AISIX 网关注入请求上下文请求头，并把允许的客户端请求头转发给 AI 服务提供方，同时保护保留请求头。 ### observability #### exporters 通过两种配置路径将 AISIX 网关请求遥测发送到 OTLP 收集器、对象存储、Datadog 或阿里云 SLS。 - [可观测性导出器](https://docs.apiseven.com/ai-gateway/observability/exporters.md): 通过两种配置路径将 AISIX 网关请求遥测发送到 OTLP 收集器、对象存储、Datadog 或阿里云 SLS。 #### load-logs-into-snowflake 将 AISIX 网关请求遥测导出到 Amazon S3 或 Azure Blob，通过 Snowpipe 摄取记录，并通过 Snowflake 视图查询。 - [将请求遥测加载到 Snowflake](https://docs.apiseven.com/ai-gateway/observability/load-logs-into-snowflake.md): 将 AISIX 网关请求遥测导出到 Amazon S3 或 Azure Blob，通过 Snowpipe 摄取记录，并通过 Snowflake 视图查询。 #### metrics-and-logs 使用 Prometheus 指标、结构化访问日志、响应头和可导出的逐次尝试用量事件监控 AISIX 网关流量。 - [指标与日志](https://docs.apiseven.com/ai-gateway/observability/metrics-and-logs.md): 使用 Prometheus 指标、结构化访问日志、响应头和可导出的逐次尝试用量事件监控 AISIX 网关流量。 ### on-premises #### deployment 规划生产资源，并通过 Docker Compose、Helm 或离线包在自有基础设施中安装 AISIX Cloud 控制面。 - [私有化安装](https://docs.apiseven.com/ai-gateway/on-premises/deployment.md): 规划生产资源，并通过 Docker Compose、Helm 或离线包在自有基础设施中安装 AISIX Cloud 控制面。 #### external-database 为使用 Helm 安装的 AISIX Cloud 控制面准备外部 PostgreSQL 数据库和最小权限角色，无需授予超级用户权限。 - [外部数据库](https://docs.apiseven.com/ai-gateway/on-premises/external-database.md): 为使用 Helm 安装的 AISIX Cloud 控制面准备外部 PostgreSQL 数据库和最小权限角色，无需授予超级用户权限。 ### providers #### adapters 了解 AISIX 网关部署可用的 OpenAI、Anthropic、Amazon Bedrock、Google Vertex AI 和 Azure OpenAI 协议适配器族。 - [适配器协议族](https://docs.apiseven.com/ai-gateway/providers/adapters.md): 了解 AISIX 网关部署可用的 OpenAI、Anthropic、Amazon Bedrock、Google Vertex AI 和 Azure OpenAI 协议适配器族。 #### amazon-nova 将 Amazon Nova 直连 API 接入 AISIX 网关部署。配置 API 凭证、Nova 模型别名、调用方 API Key 和模型访问控制。 - [Amazon Nova API](https://docs.apiseven.com/ai-gateway/providers/amazon-nova.md): 将 Amazon Nova 直连 API 接入 AISIX 网关部署。配置 API 凭证、Nova 模型别名、调用方 API Key 和模型访问控制。 #### anthropic 通过原生 Messages API 或兼容 OpenAI 的 API，将 Anthropic Claude 接入 AISIX 网关部署，并配置凭证、模型别名和调用方访问权限。 - [Anthropic](https://docs.apiseven.com/ai-gateway/providers/anthropic.md): 通过原生 Messages API 或兼容 OpenAI 的 API，将 Anthropic Claude 接入 AISIX 网关部署，并配置凭证、模型别名和调用方访问权限。 #### aws-bedrock 使用 SigV4 将 AWS Bedrock 接入 AISIX 网关部署，并配置区域端点、模型或推理配置文件别名、调用方密钥和访问控制。 - [AWS Bedrock](https://docs.apiseven.com/ai-gateway/providers/aws-bedrock.md): 使用 SigV4 将 AWS Bedrock 接入 AISIX 网关部署，并配置区域端点、模型或推理配置文件别名、调用方密钥和访问控制。 #### azure-openai 使用资源 API Key 或 Microsoft Entra ID 将 Azure OpenAI 接入 AISIX 网关部署，并配置部署别名、调用方密钥和访问控制。 - [Azure OpenAI](https://docs.apiseven.com/ai-gateway/providers/azure-openai.md): 使用资源 API Key 或 Microsoft Entra ID 将 Azure OpenAI 接入 AISIX 网关部署，并配置部署别名、调用方密钥和访问控制。 #### baseten 将 Baseten Model APIs 或专用端点接入 AISIX 网关部署。配置凭证、模型别名、调用方密钥和访问控制。 - [Baseten](https://docs.apiseven.com/ai-gateway/providers/baseten.md): 将 Baseten Model APIs 或专用端点接入 AISIX 网关部署。配置凭证、模型别名、调用方密钥和访问控制。 #### bring-your-own-endpoint 将 AISIX 网关部署连接到 vLLM、SGLang 或 Ollama 等私有 OpenAI 兼容端点，并配置凭证、别名和自定义 Token 定价。 - [自带端点](https://docs.apiseven.com/ai-gateway/providers/bring-your-own-endpoint.md): 将 AISIX 网关部署连接到 vLLM、SGLang 或 Ollama 等私有 OpenAI 兼容端点，并配置凭证、别名和自定义 Token 定价。 #### cerebras 通过 OpenAI 兼容 API 将 Cerebras Inference 接入 AISIX 网关部署。配置凭证、模型别名、调用方密钥和访问控制。 - [Cerebras](https://docs.apiseven.com/ai-gateway/providers/cerebras.md): 通过 OpenAI 兼容 API 将 Cerebras Inference 接入 AISIX 网关部署。配置凭证、模型别名、调用方密钥和访问控制。 #### cloudflare-workers-ai 将 Cloudflare Workers AI 接入 AISIX 网关部署。配置账户范围端点、API 凭证、@cf 模型 ID、别名和调用方访问权限。 - [Cloudflare Workers AI](https://docs.apiseven.com/ai-gateway/providers/cloudflare-workers-ai.md): 将 Cloudflare Workers AI 接入 AISIX 网关部署。配置账户范围端点、API 凭证、@cf 模型 ID、别名和调用方访问权限。 #### cohere 将 Cohere 接入 AISIX 网关部署，用于 Command 聊天模型、Embedding 和 rerank。配置服务提供方凭证、模型别名和调用方访问权限。 - [Cohere](https://docs.apiseven.com/ai-gateway/providers/cohere.md): 将 Cohere 接入 AISIX 网关部署，用于 Command 聊天模型、Embedding 和 rerank。配置服务提供方凭证、模型别名和调用方访问权限。 #### compatibility 对比 AISIX 网关部署中的服务提供方协议和代理端点支持，包括聊天、向量嵌入、图片生成、视频生成和 Rerank。 - [服务提供方兼容性](https://docs.apiseven.com/ai-gateway/providers/compatibility.md): 对比 AISIX 网关部署中的服务提供方协议和代理端点支持，包括聊天、向量嵌入、图片生成、视频生成和 Rerank。 #### databricks 将 Databricks Model Serving 接入 AISIX 网关部署。配置工作区端点、服务提供方凭证、模型别名、调用方密钥和访问控制。 - [Databricks](https://docs.apiseven.com/ai-gateway/providers/databricks.md): 将 Databricks Model Serving 接入 AISIX 网关部署。配置工作区端点、服务提供方凭证、模型别名、调用方密钥和访问控制。 #### deepinfra 通过 DeepInfra 的 OpenAI 兼容 API 将其接入 AISIX 网关部署。配置明确的端点、凭证、模型别名和调用方访问权限。 - [DeepInfra](https://docs.apiseven.com/ai-gateway/providers/deepinfra.md): 通过 DeepInfra 的 OpenAI 兼容 API 将其接入 AISIX 网关部署。配置明确的端点、凭证、模型别名和调用方访问权限。 #### deepseek 通过 OpenAI 兼容 API 将 DeepSeek 模型接入 AISIX 网关部署，并配置服务提供方凭证、模型别名、调用方密钥和访问控制。 - [DeepSeek](https://docs.apiseven.com/ai-gateway/providers/deepseek.md): 通过 OpenAI 兼容 API 将 DeepSeek 模型接入 AISIX 网关部署，并配置服务提供方凭证、模型别名、调用方密钥和访问控制。 #### digitalocean-gradient-ai 将 DigitalOcean Gradient AI 连接到 AISIX 网关部署，配置 Serverless Inference 凭证、模型别名、调用方 API Key 和访问控制。 - [DigitalOcean Gradient AI](https://docs.apiseven.com/ai-gateway/providers/digitalocean-gradient-ai.md): 将 DigitalOcean Gradient AI 连接到 AISIX 网关部署，配置 Serverless Inference 凭证、模型别名、调用方 API Key 和访问控制。 #### fireworks-ai 通过 Fireworks AI 的 OpenAI 兼容 API 将其连接到 AISIX 网关部署，配置服务提供方凭证、模型别名、调用方密钥和访问控制。 - [Fireworks AI](https://docs.apiseven.com/ai-gateway/providers/fireworks-ai.md): 通过 Fireworks AI 的 OpenAI 兼容 API 将其连接到 AISIX 网关部署，配置服务提供方凭证、模型别名、调用方密钥和访问控制。 #### gemini 通过 AI Studio 兼容 OpenAI 的 API 将 Google Gemini 接入 AISIX 网关部署。配置凭证、模型别名、调用方密钥和访问控制。 - [Gemini (Google AI Studio)](https://docs.apiseven.com/ai-gateway/providers/gemini.md): 通过 AI Studio 兼容 OpenAI 的 API 将 Google Gemini 接入 AISIX 网关部署。配置凭证、模型别名、调用方密钥和访问控制。 #### google-vertex-ai 将 Google Vertex AI 接入 AISIX。配置服务账号凭证、全局或区域端点与模型别名，并了解适配器限制。 - [Google Vertex AI](https://docs.apiseven.com/ai-gateway/providers/google-vertex-ai.md): 将 Google Vertex AI 接入 AISIX。配置服务账号凭证、全局或区域端点与模型别名，并了解适配器限制。 #### groq 将 Groq 接入 AISIX。配置凭证和模型别名，并了解 Chat、Responses、音频、批处理和服务提供方特定限制。 - [Groq](https://docs.apiseven.com/ai-gateway/providers/groq.md): 将 Groq 接入 AISIX。配置凭证和模型别名，并了解 Chat、Responses、音频、批处理和服务提供方特定限制。 #### huggingface 将 Hugging Face Inference Providers 接入 AISIX。配置路由器凭证和模型别名，并了解路由与服务商边界。 - [Hugging Face](https://docs.apiseven.com/ai-gateway/providers/huggingface.md): 将 Hugging Face Inference Providers 接入 AISIX。配置路由器凭证和模型别名，并了解路由与服务商边界。 #### jina 将 Jina AI Embedding 和重排序模型接入 AISIX 网关部署，并了解模型、路由、透传和核算边界。 - [Jina](https://docs.apiseven.com/ai-gateway/providers/jina.md): 将 Jina AI Embedding 和重排序模型接入 AISIX 网关部署，并了解模型、路由、透传和核算边界。 #### meta-llama-api 通过兼容 OpenAI 的端点将 Meta Llama API 接入 AISIX，并使用正确的 API Base、示例模型和路由边界。 - [Meta Llama API](https://docs.apiseven.com/ai-gateway/providers/meta-llama-api.md): 通过兼容 OpenAI 的端点将 Meta Llama API 接入 AISIX，并使用正确的 API Base、示例模型和路由边界。 #### minimax 通过兼容 OpenAI 的 API 将 MiniMax 模型接入 AISIX 网关部署。配置明确的端点、凭证、别名和调用方访问权限。 - [MiniMax](https://docs.apiseven.com/ai-gateway/providers/minimax.md): 通过兼容 OpenAI 的 API 将 MiniMax 模型接入 AISIX 网关部署。配置明确的端点、凭证、别名和调用方访问权限。 #### mistral 将 Mistral AI 接入 AISIX 的 Chat 和兼容端点，并配置模型别名、结构化响应边界与原生 API 透传。 - [Mistral AI](https://docs.apiseven.com/ai-gateway/providers/mistral.md): 将 Mistral AI 接入 AISIX 的 Chat 和兼容端点，并配置模型别名、结构化响应边界与原生 API 透传。 #### modelscope 将 ModelScope API-Inference 接入 AISIX 网关部署。配置兼容 OpenAI 的端点、带命名空间的模型 ID、模型服务提供方密钥和调用方访问权限。 - [ModelScope](https://docs.apiseven.com/ai-gateway/providers/modelscope.md): 将 ModelScope API-Inference 接入 AISIX 网关部署。配置兼容 OpenAI 的端点、带命名空间的模型 ID、模型服务提供方密钥和调用方访问权限。 #### moonshotai 将 Moonshot AI 和 Kimi 模型接入 AISIX 网关部署。配置区域端点、凭证、模型别名、思考模式和调用方访问权限。 - [Moonshot AI（Kimi）](https://docs.apiseven.com/ai-gateway/providers/moonshotai.md): 将 Moonshot AI 和 Kimi 模型接入 AISIX 网关部署。配置区域端点、凭证、模型别名、思考模式和调用方访问权限。 #### nebius-token-factory 通过兼容 OpenAI 的 API 将 Nebius Token Factory 接入 AISIX，并配置模型别名、端点兼容性和原生 API 透传。 - [Nebius Token Factory](https://docs.apiseven.com/ai-gateway/providers/nebius-token-factory.md): 通过兼容 OpenAI 的 API 将 Nebius Token Factory 接入 AISIX，并配置模型别名、端点兼容性和原生 API 透传。 #### novita-ai 通过兼容 OpenAI 的 API 将 Novita AI 接入 AISIX，并配置模型别名、端点兼容性、批处理工作流和原生透传。 - [Novita AI](https://docs.apiseven.com/ai-gateway/providers/novita-ai.md): 通过兼容 OpenAI 的 API 将 Novita AI 接入 AISIX，并配置模型别名、端点兼容性、批处理工作流和原生透传。 #### nvidia-nim 将托管或私有部署的 NVIDIA NIM 模型连接到 AISIX 网关部署，并配置端点凭证、带命名空间的模型别名和调用方访问权限。 - [NVIDIA NIM](https://docs.apiseven.com/ai-gateway/providers/nvidia-nim.md): 将托管或私有部署的 NVIDIA NIM 模型连接到 AISIX 网关部署，并配置端点凭证、带命名空间的模型别名和调用方访问权限。 #### ollama 通过 OpenAI 兼容 API 将本地或私有 Ollama 服务器接入 AISIX 网关部署，并配置端点、模型别名和调用方访问权限。 - [Ollama](https://docs.apiseven.com/ai-gateway/providers/ollama.md): 通过 OpenAI 兼容 API 将本地或私有 Ollama 服务器接入 AISIX 网关部署，并配置端点、模型别名和调用方访问权限。 #### openai 将 OpenAI 模型接入 AISIX 网关部署，并配置凭证、模型别名、调用方 API Key、访问控制、限流和请求验证。 - [OpenAI](https://docs.apiseven.com/ai-gateway/providers/openai.md): 将 OpenAI 模型接入 AISIX 网关部署，并配置凭证、模型别名、调用方 API Key、访问控制、限流和请求验证。 #### openai-compatible-vendors 使用明确的 API 端点、服务提供方凭证、模型别名和调用方密钥，在 AISIX 网关部署中配置公开的 OpenAI 兼容 LLM 服务提供方。 - [其他 OpenAI 兼容服务提供方](https://docs.apiseven.com/ai-gateway/providers/openai-compatible-vendors.md): 使用明确的 API 端点、服务提供方凭证、模型别名和调用方密钥，在 AISIX 网关部署中配置公开的 OpenAI 兼容 LLM 服务提供方。 #### openrouter 通过 OpenAI 兼容 API 将 OpenRouter 连接到 AISIX 网关部署。配置凭证、带命名空间的模型 ID、别名和调用方访问权限。 - [OpenRouter](https://docs.apiseven.com/ai-gateway/providers/openrouter.md): 通过 OpenAI 兼容 API 将 OpenRouter 连接到 AISIX 网关部署。配置凭证、带命名空间的模型 ID、别名和调用方访问权限。 #### overview 对比 AISIX 网关部署支持的托管 AI 服务提供方接口和私有模型服务器，包括原生适配器、社区服务提供方、Ollama 和 vLLM。 - [选择服务提供方上游](https://docs.apiseven.com/ai-gateway/providers/overview.md): 对比 AISIX 网关部署支持的托管 AI 服务提供方接口和私有模型服务器，包括原生适配器、社区服务提供方、Ollama 和 vLLM。 #### ovhcloud-ai-endpoints 通过 OpenAI 兼容 API 将 OVHcloud AI Endpoints 连接到 AISIX 网关部署，并配置凭证、模型别名、调用方密钥和访问控制。 - [OVHcloud AI Endpoints](https://docs.apiseven.com/ai-gateway/providers/ovhcloud-ai-endpoints.md): 通过 OpenAI 兼容 API 将 OVHcloud AI Endpoints 连接到 AISIX 网关部署，并配置凭证、模型别名、调用方密钥和访问控制。 #### perplexity 通过 OpenAI 兼容 API 将 Perplexity Sonar 模型连接到 AISIX 网关部署，并配置凭证、模型别名、调用方密钥和访问控制。 - [Perplexity](https://docs.apiseven.com/ai-gateway/providers/perplexity.md): 通过 OpenAI 兼容 API 将 Perplexity Sonar 模型连接到 AISIX 网关部署，并配置凭证、模型别名、调用方密钥和访问控制。 #### qwen 将阿里云 Qwen 模型接入 AISIX 网关部署，并配置区域 DashScope 端点、凭证、模型别名和调用方访问权限。 - [Qwen（阿里云）](https://docs.apiseven.com/ai-gateway/providers/qwen.md): 将阿里云 Qwen 模型接入 AISIX 网关部署，并配置区域 DashScope 端点、凭证、模型别名和调用方访问权限。 #### runwayml 通过 AISIX 视频 API 将 RunwayML 视频生成连接到 AISIX 网关部署，并配置凭证、模型别名、调用方密钥和访问控制。 - [RunwayML](https://docs.apiseven.com/ai-gateway/providers/runwayml.md): 通过 AISIX 视频 API 将 RunwayML 视频生成连接到 AISIX 网关部署，并配置凭证、模型别名、调用方密钥和访问控制。 #### siliconflow 通过 OpenAI 兼容 API 将 SiliconFlow 连接到 AISIX 网关部署。配置凭证、带命名空间的模型 ID、别名和调用方访问权限。 - [SiliconFlow](https://docs.apiseven.com/ai-gateway/providers/siliconflow.md): 通过 OpenAI 兼容 API 将 SiliconFlow 连接到 AISIX 网关部署。配置凭证、带命名空间的模型 ID、别名和调用方访问权限。 #### snowflake-cortex 将 Snowflake Cortex 连接到 AISIX 网关部署。配置账户专用的 OpenAI 兼容端点、凭证、模型别名和调用方访问权限。 - [Snowflake Cortex](https://docs.apiseven.com/ai-gateway/providers/snowflake-cortex.md): 将 Snowflake Cortex 连接到 AISIX 网关部署。配置账户专用的 OpenAI 兼容端点、凭证、模型别名和调用方访问权限。 #### together 通过 OpenAI 兼容 API 将 Together AI 接入 AISIX 网关部署，并配置服务提供方凭证、模型别名、调用方密钥和访问控制。 - [Together AI](https://docs.apiseven.com/ai-gateway/providers/together.md): 通过 OpenAI 兼容 API 将 Together AI 接入 AISIX 网关部署，并配置服务提供方凭证、模型别名、调用方密钥和访问控制。 #### vllm 将私有 vLLM OpenAI 兼容服务器接入 AISIX 网关部署，并配置端点凭证、所提供模型的别名、调用方密钥和访问控制。 - [vLLM](https://docs.apiseven.com/ai-gateway/providers/vllm.md): 将私有 vLLM OpenAI 兼容服务器接入 AISIX 网关部署，并配置端点凭证、所提供模型的别名、调用方密钥和访问控制。 #### volcengine-ark 将 Volcengine Ark 连接到 AISIX 网关部署，以使用豆包聊天和 Seedance 视频生成功能。配置凭证、模型别名和调用方访问权限。 - [Volcengine Ark (Doubao)](https://docs.apiseven.com/ai-gateway/providers/volcengine-ark.md): 将 Volcengine Ark 连接到 AISIX 网关部署，以使用豆包聊天和 Seedance 视频生成功能。配置凭证、模型别名和调用方访问权限。 #### wandb-inference 通过 OpenAI 兼容 API 将 Weights & Biases Inference 连接到 AISIX 网关部署。配置凭证、模型别名和调用方访问权限。 - [Weights & Biases Inference](https://docs.apiseven.com/ai-gateway/providers/wandb-inference.md): 通过 OpenAI 兼容 API 将 Weights & Biases Inference 连接到 AISIX 网关部署。配置凭证、模型别名和调用方访问权限。 #### xai 通过 OpenAI 兼容 API 将 xAI Grok 模型连接到 AISIX 网关部署。配置区域端点、凭证、别名和调用方访问权限。 - [xAI (Grok)](https://docs.apiseven.com/ai-gateway/providers/xai.md): 通过 OpenAI 兼容 API 将 xAI Grok 模型连接到 AISIX 网关部署。配置区域端点、凭证、别名和调用方访问权限。 #### zhipuai 将 Zhipu AI 接入 AISIX 网关部署，用于 GLM Chat 和 CogVideoX 视频生成，并配置 API 凭证、模型别名和调用方访问权限。 - [Zhipu AI (GLM)](https://docs.apiseven.com/ai-gateway/providers/zhipuai.md): 将 Zhipu AI 接入 AISIX 网关部署，用于 GLM Chat 和 CogVideoX 视频生成，并配置 API 凭证、模型别名和调用方访问权限。 ### reference #### cli AISIX 网关命令参考，包括验证声明式资源以及将 etcd 配置导出到 resources.yaml 文件。 - [CLI 参考](https://docs.apiseven.com/ai-gateway/reference/cli.md): AISIX 网关命令参考，包括验证声明式资源以及将 etcd 配置导出到 resources.yaml 文件。 #### config-status AISIX 网关配置状态端点和指标参考，包括已应用、被拒绝、使用陈旧值提供服务和部分兼容的资源。 - [配置状态](https://docs.apiseven.com/ai-gateway/reference/config-status.md): AISIX 网关配置状态端点和指标参考，包括已应用、被拒绝、使用陈旧值提供服务和部分兼容的资源。 #### configuration-files AISIX 网关启动配置格式、资源来源、连接设置、加载优先级和常用选项参考。 - [启动配置参考](https://docs.apiseven.com/ai-gateway/reference/configuration-files.md): AISIX 网关启动配置格式、资源来源、连接设置、加载优先级和常用选项参考。 #### environment-variables AISIX AI 网关用于配置文件、启动覆盖、AISIX 网关和运行时调优的环境变量参考。 - [环境变量](https://docs.apiseven.com/ai-gateway/reference/environment-variables.md): AISIX AI 网关用于配置文件、启动覆盖、AISIX 网关和运行时调优的环境变量参考。 #### headers-and-error-codes AISIX 网关代理、MCP、A2A 和透传路由的响应头、状态码与错误信封参考。 - [响应头与错误码](https://docs.apiseven.com/ai-gateway/reference/headers-and-error-codes.md): AISIX 网关代理、MCP、A2A 和透传路由的响应头、状态码与错误信封参考。 #### metrics AISIX AI 网关公开的 Prometheus 指标参考。 - [指标参考](https://docs.apiseven.com/ai-gateway/reference/metrics.md): AISIX AI 网关公开的 Prometheus 指标参考。 #### on-premises-configuration 在自有基础设施中运行 AISIX Cloud 控制面所使用的 Docker Compose 环境变量和 Helm values 参考。 - [On-Premises 配置](https://docs.apiseven.com/ai-gateway/reference/on-premises-configuration.md): 在自有基础设施中运行 AISIX Cloud 控制面所使用的 Docker Compose 环境变量和 Helm values 参考。 #### ports AISIX 网关和 AISIX Cloud 控制面的默认端口、流量方向、配置方式与建议网络暴露范围参考。 - [端口参考](https://docs.apiseven.com/ai-gateway/reference/ports.md): AISIX 网关和 AISIX Cloud 控制面的默认端口、流量方向、配置方式与建议网络暴露范围参考。 #### proxy-api AISIX 网关代理路由、身份认证、模型发现、路由行为和端点约束参考。 - [代理 API 参考](https://docs.apiseven.com/ai-gateway/reference/proxy-api.md): AISIX 网关代理路由、身份认证、模型发现、路由行为和端点约束参考。 #### resources-file 使用本参考中的受支持集合、字段、环境变量插值和校验规则，通过 resources.yaml 配置 AISIX AI 网关。 - [资源文件参考](https://docs.apiseven.com/ai-gateway/reference/resources-file.md): 使用本参考中的受支持集合、字段、环境变量插值和校验规则，通过 resources.yaml 配置 AISIX AI 网关。 ### release-notes 各 AISIX AI 网关版本的新功能、改进和修复。 - [发布说明](https://docs.apiseven.com/ai-gateway/release-notes.md): 各 AISIX AI 网关版本的新功能、改进和修复。 ### routing #### ensemble-models 在 AISIX 网关部署中配置合议模型，以并发分发聊天请求、合成合议成员响应，并管理延迟、成本和失败。 - [合议模型](https://docs.apiseven.com/ai-gateway/routing/ensemble-models.md): 在 AISIX 网关部署中配置合议模型，以并发分发聊天请求、合成合议成员响应，并管理延迟、成本和失败。 #### proxy-errors-and-retries 了解客户端应用应如何处理 AISIX AI 网关代理错误、重试信号和上游故障。 - [代理错误与重试](https://docs.apiseven.com/ai-gateway/routing/proxy-errors-and-retries.md): 了解客户端应用应如何处理 AISIX AI 网关代理错误、重试信号和上游故障。 #### routing-and-failover 在 AISIX 网关部署中配置并测试多目标路由和故障转移，包括选择策略、重试、运行时过滤和恢复。 - [多目标路由与故障转移](https://docs.apiseven.com/ai-gateway/routing/routing-and-failover.md): 在 AISIX 网关部署中配置并测试多目标路由和故障转移，包括选择策略、重试、运行时过滤和恢复。 #### semantic-routing 在 AISIX 网关部署中配置语义路由，根据请求语义选择直接模型、调整相似度阈值，并定义安全的回退行为。 - [语义路由](https://docs.apiseven.com/ai-gateway/routing/semantic-routing.md): 在 AISIX 网关部署中配置语义路由，根据请求语义选择直接模型、调整相似度阈值，并定义安全的回退行为。 ### traffic-controls #### budget-alerts 配置 AISIX Cloud 预算告警，在 AI 支出超过预算限额的指定百分比时，通过 Webhook 或 Slack 通知运维人员。 - [预算告警与通知](https://docs.apiseven.com/ai-gateway/traffic-controls/budget-alerts.md): 配置 AISIX Cloud 预算告警，在 AI 支出超过预算限额的指定百分比时，通过 Webhook 或 Slack 通知运维人员。 #### budgets 配置 AISIX Cloud 预算，在组织、环境、调用方 API Key、服务提供方密钥、团队和成员范围内执行 AI 支出限额。 - [预算](https://docs.apiseven.com/ai-gateway/traffic-controls/budgets.md): 配置 AISIX Cloud 预算，在组织、环境、调用方 API Key、服务提供方密钥、团队和成员范围内执行 AI 支出限额。 #### caching 在 AISIX Cloud 和开源 AISIX 网关部署中，为符合条件的 Chat Completions 请求配置 Memory 或 Redis 响应缓存。 - [响应缓存](https://docs.apiseven.com/ai-gateway/traffic-controls/caching.md): 在 AISIX Cloud 和开源 AISIX 网关部署中，为符合条件的 Chat Completions 请求配置 Memory 或 Redis 响应缓存。 #### caller-api-keys 配置 AISIX 网关部署的调用方 API Key，包括模型访问控制、过期、禁用、轮换、身份认证和验证。 - [调用方 API Key](https://docs.apiseven.com/ai-gateway/traffic-controls/caller-api-keys.md): 配置 AISIX 网关部署的调用方 API Key，包括模型访问控制、过期、禁用、轮换、身份认证和验证。 #### claim-mappings 通过按优先级排序的规则，把验证通过的 JWT Claims（部门、群组、应用）解析到调用方 API Key，让一整类身份共享受治理的访问权限，同时保留按身份的用量归因。 - [JWT Claim 映射](https://docs.apiseven.com/ai-gateway/traffic-controls/claim-mappings.md): 通过按优先级排序的规则，把验证通过的 JWT Claims（部门、群组、应用）解析到调用方 API Key，让一整类身份共享受治理的访问权限，同时保留按身份的用量归因。 #### guardrails - [Alibaba Cloud Content Moderation](https://docs.apiseven.com/ai-gateway/traffic-controls/guardrails/alibaba-cloud-ai.md): 通过 AISIX Cloud 或资源文件配置 Alibaba Cloud Content Moderation，并验证 TextModerationPlus 风险等级执行行为。 - [Alibaba Cloud AI Guardrails](https://docs.apiseven.com/ai-gateway/traffic-controls/guardrails/alibaba-cloud-ai-guardrails.md): 通过 AISIX Cloud 或资源文件配置 Alibaba Cloud AI Guardrails，并验证 MultiModalGuard 阻断和敏感数据脱敏。 - [AWS Bedrock Guardrails](https://docs.apiseven.com/ai-gateway/traffic-controls/guardrails/aws-bedrock.md): 通过 AISIX Cloud 或资源文件配置 AWS Bedrock Guardrails，并在 AISIX AI 网关中验证阻断和 PII 匿名化。 - [Azure AI Content Safety 安全护栏](https://docs.apiseven.com/ai-gateway/traffic-controls/guardrails/azure-content-safety.md): 通过 AISIX Cloud 或资源文件配置 Azure AI Content Safety，并在 AISIX 中验证 Prompt Shield 和 Text Moderation 行为。 - [安全护栏行为](https://docs.apiseven.com/ai-gateway/traffic-controls/guardrails/behavior.md): 了解 AISIX 安全护栏的检查位置、执行模式、作用域差异、流式输出控制、远程故障和调用方行为。 - [内置关键词安全护栏](https://docs.apiseven.com/ai-gateway/traffic-controls/guardrails/keyword.md): 通过 AISIX Cloud 或资源文件配置 AISIX 内置关键词安全护栏，并验证阻断、监控模式和作用域行为。 - [Lakera Guard](https://docs.apiseven.com/ai-gateway/traffic-controls/guardrails/lakera.md): 通过 AISIX Cloud 或资源文件配置 Lakera Guard，并在 AISIX AI 网关中验证提示词注入阻断和 PII 脱敏。 - [OpenAI Moderation 安全护栏](https://docs.apiseven.com/ai-gateway/traffic-controls/guardrails/openai-moderation.md): 通过 AISIX Cloud 或资源文件配置 OpenAI Moderation，并在 AISIX AI 网关中验证阻断及按分类调整阈值。 - [选择安全护栏服务提供方](https://docs.apiseven.com/ai-gateway/traffic-controls/guardrails/overview.md): 按评估位置、检测范围、执行操作和配置路径，比较 AISIX 内置及远程安全护栏服务提供方。 - [PII 检测与脱敏](https://docs.apiseven.com/ai-gateway/traffic-controls/guardrails/pii.md): 通过 AISIX Cloud 或资源文件配置 AISIX 内置 PII 检测，并验证脱敏、阻断和自定义敏感数据模式。 - [Microsoft Presidio 安全护栏](https://docs.apiseven.com/ai-gateway/traffic-controls/guardrails/presidio.md): 通过 AISIX Cloud 或资源文件配置 Microsoft Presidio，并使用自托管分析验证 PII 匿名化和阻断。 #### jwt-authentication 在 AISIX 网关部署中配置 OIDC 信任和 JWT 认证，包括签发者发现、声明校验，以及将外部身份映射到调用方 API Key。 - [JWT 认证](https://docs.apiseven.com/ai-gateway/traffic-controls/jwt-authentication.md): 在 AISIX 网关部署中配置 OIDC 信任和 JWT 认证，包括签发者发现、声明校验，以及将外部身份映射到调用方 API Key。 #### keycloak-integration 一份经过完整验证的端到端指南——配置 Keycloak Realm，让其中的用户直接用自己的 JWT 在网关认证，并通过 Claim 映射把部门和群组解析到调用方 API Key。 - [Keycloak 集成](https://docs.apiseven.com/ai-gateway/traffic-controls/keycloak-integration.md): 一份经过完整验证的端到端指南——配置 Keycloak Realm，让其中的用户直接用自己的 JWT 在网关认证，并通过 Claim 映射把部门和群组解析到调用方 API Key。 #### overview 了解限流、预算、安全护栏和缓存在 AISIX 请求链路中的位置。 - [流量控制](https://docs.apiseven.com/ai-gateway/traffic-controls/overview.md): 了解限流、预算、安全护栏和缓存在 AISIX 请求链路中的位置。 #### prompt-caching 在 AISIX Cloud 或开源 AISIX 网关中启用 Anthropic 自动提示词缓存，使重复的提示词前缀获得模型服务提供方缓存折扣。 - [Anthropic 提示词缓存](https://docs.apiseven.com/ai-gateway/traffic-controls/prompt-caching.md): 在 AISIX Cloud 或开源 AISIX 网关中启用 Anthropic 自动提示词缓存，使重复的提示词前缀获得模型服务提供方缓存折扣。 #### rate-limit-policies 配置支持条件流量匹配、独立配额桶、经典单作用域规则和暂停计划的 AISIX 限流策略。 - [限流策略](https://docs.apiseven.com/ai-gateway/traffic-controls/rate-limit-policies.md): 配置支持条件流量匹配、独立配额桶、经典单作用域规则和暂停计划的 AISIX 限流策略。 #### rate-limits 在 AISIX Cloud 和开源 AISIX 网关中配置并验证调用方 API Key 与模型的请求数、Token 和并发限制。 - [API Key 与模型限流](https://docs.apiseven.com/ai-gateway/traffic-controls/rate-limits.md): 在 AISIX Cloud 和开源 AISIX 网关中配置并验证调用方 API Key 与模型的请求数、Token 和并发限制。 #### semantic-caching 基于向量相似度为语义相近的提示词返回缓存的 Chat Completions 响应，支持配置阈值、共享范围与缓存清空。 - [语义缓存](https://docs.apiseven.com/ai-gateway/traffic-controls/semantic-caching.md): 基于向量相似度为语义相近的提示词返回缓存的 Chat Completions 响应，支持配置阈值、共享范围与缓存清空。 ## api7-gateway ### 3.9.x #### ai-gateway - [5 分钟代理第一个大语言模型请求](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/get-started.md): 在 5 分钟内配置 API7 AI 网关并代理第一个 OpenAI 请求，包含分步说明和代码示例。 - [接入 Anthropic Claude](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/llm-providers/anthropic.md): 通过 API7 网关路由 Anthropic Claude API 流量，集中实施安全、限流和可观测性策略。 - [集成 Azure OpenAI Service](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/llm-providers/azure-openai.md): 通过 API7 网关管理 Azure OpenAI Deployment，集中处理资源名称、API 版本和身份认证。 - [将流量路由到 DeepSeek 模型](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/llm-providers/deepseek.md): 通过 API7 网关代理 DeepSeek API 请求，集中管理身份认证、启用故障转移并监控用量。 - [接入 Google Gemini](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/llm-providers/google-gemini.md): 通过 API7 网关代理 Google Gemini API 请求，集中管理 API Key（API 密钥）并监控 AI 流量。 - [将流量路由到 OpenAI](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/llm-providers/openai.md): 通过 API7 网关代理和保护 OpenAI API 请求，集中管理身份认证、启用故障转移并监控用量。 - [接入任意 OpenAI 兼容大语言模型](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/llm-providers/openai-compatible.md): 通过 API7 网关代理任意 OpenAI 兼容 API，接入自托管模型、自定义端点或小众服务提供方。 - [通过 OpenRouter 接入数百种大语言模型](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/llm-providers/openrouter.md): 通过 API7 AI 网关接入 OpenRouter，使用一个 API 访问 200 多种大语言模型，同时保持企业级安全控制。 - [将企业 AI 流量路由到 Vertex AI](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/llm-providers/vertex-ai.md): 通过 API7 网关安全代理 Google Cloud Vertex AI 请求，支持服务账户身份认证和区域路由。 - [管理和保护 AI 流量](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/overview.md): 使用 API7 AI 网关集中管理大语言模型访问，通过一个平台将流量路由到多个服务提供方、实施安全护栏并控制成本。 - [监控 AI 流量并跟踪大语言模型成本](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/use-cases/ai-observability-and-cost-tracking.md): 使用 API7 AI 网关的可观测性功能，洞察大语言模型用量、Token 消耗、延迟和成本。 - [使用 AI 重写转换 API 请求](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/use-cases/ai-request-transformation.md): 在网关层使用大语言模型智能地转换、丰富或重构 API 请求与响应。 - [实施 AI 安全护栏并保护 PII](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/use-cases/content-safety-and-guardrails.md): 使用 API7 AI 网关安全护栏，在请求到达大语言模型前阻止提示词注入、检测有害内容并脱敏 PII。 - [将 REST API 暴露为 AI Agent 的 MCP 工具](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/use-cases/expose-apis-as-mcp-tools.md): 将现有 OpenAPI 服务转换为 MCP 兼容工具，使 AI Agent（AI 智能体）能够自动发现并调用 API。 - [通过 API7-MCP 在 AI 客户端中管理 API7 企业版](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/use-cases/manage-api7-with-mcp.md): 部署 API7-MCP，让 Cursor、Claude Desktop、Cline 等 AI 客户端读取 API7 企业版资源、查看 Prometheus 指标、管理基于角色的访问控制（RBAC），并通过网关发送测试流量。 - [配置多模型路由和自动故障转移](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/use-cases/multi-llm-routing-and-fallback.md): 使用加权负载均衡、自动故障转移和健康检查，在多个模型服务提供方之间路由 AI 流量。 - [实现提示词模板和装饰器](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/use-cases/prompt-engineering-and-templating.md): 使用 API7 AI 网关的可复用提示词模板和自动系统提示词注入，规范大语言模型交互。 - [将 Anthropic Messages 转换为 OpenAI Chat Completions](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/use-cases/protocol-conversion.md): 使用 API7 AI 网关透明地将 Anthropic Messages API 请求转换为 OpenAI Chat Completions API 格式，使团队能够通过 Anthropic SDK 使用任意 OpenAI 兼容后端。 - [在网关层实现 RAG](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/use-cases/retrieval-augmented-generation.md): 使用 API7 AI 网关内置的检索增强生成（RAG），通过相关上下文提升大语言模型响应质量。 - [使用基于 Token 的限流控制 AI 成本](https://docs.apiseven.com/api7-gateway/3.9.x/ai-gateway/use-cases/token-rate-limiting-and-quota-management.md): 实施基于 Token 的限流，防止大语言模型被滥用，并按路由和模型实例控制 AI 成本。 #### api-consumption - [应用基于列表的访问控制](https://docs.apiseven.com/api7-gateway/3.9.x/api-consumption/consumer-restriction.md): 遵循本指南在 API7 企业版中实施基于列表的访问控制，通过白名单和黑名单实现对消费者访问的精确管理。 - [管理消费者凭证](https://docs.apiseven.com/api7-gateway/3.9.x/api-consumption/manage-consumer-credentials.md): 按照本指南在 API7 企业版中管理消费者凭证，使你能够设置和配置各种 API 访问的身份验证方法。 #### api-observability - [触发网关告警](https://docs.apiseven.com/api7-gateway/3.9.x/api-observability/alert.md): 按照本指南在 API7 企业版中创建告警策略，以便接收特定事件的通知并监控系统性能。 - [在访问日志中记录消费者标签](https://docs.apiseven.com/api7-gateway/3.9.x/api-observability/log-consumer-label-in-access-log.md): 按照本指南在 API7 企业版的访问日志中记录消费者标签，以增强 API 的管理和安全性。 - [记录 API 流量日志](https://docs.apiseven.com/api7-gateway/3.9.x/api-observability/logging.md): 按照本指南在 API7 企业版中配置 API 流量日志记录，与各种日志平台集成以捕获详细的访问日志。 - [监控 API 指标](https://docs.apiseven.com/api7-gateway/3.9.x/api-observability/monitoring.md): 按照本指南在 API7 企业版中监控 API 指标，利用 Prometheus 插件来有效追踪和可视化 HTTP 指标。 - [追踪 API 流量](https://docs.apiseven.com/api7-gateway/3.9.x/api-observability/tracing.md): 按照本指南在 API7 企业版中使用 opentelemetry 插件设置追踪，实现对请求在系统中的旅程的监控。 #### api-portal - [自定义开发者门户](https://docs.apiseven.com/api7-gateway/3.9.x/api-portal/custom-portal.md): 使用 API7 开发者门户脚手架自定义开发者门户，包括配置、品牌化、SSO 集成以及 Portal SDK。 - [使用 Okta 为开发者门户配置 SCIM 自动配置](https://docs.apiseven.com/api7-gateway/3.9.x/api-portal/custom-portal-enable-scim-okta.md): 了解如何使用 Okta 为你的自定义开发者门户配置 SCIM 自动配置（Provisioning），从而实现自动化的用户同步。 - [使用提供方门户设置开发者门户](https://docs.apiseven.com/api7-gateway/3.9.x/api-portal/getting-started.md): 了解如何通过将提供方门户与示例开发者门户连接，来设置和使用 API7 API 开发者门户，以发布 API 并管理开发者访问权限。 - [使用 Keycloak 配置动态客户端注册（DCR）](https://docs.apiseven.com/api7-gateway/3.9.x/api-portal/keycloak-dcr.md): 了解如何使用动态客户端注册（DCR）将 API7 企业版开发者门户与 Keycloak 集成，以进行 OAuth 2.0 身份验证。 - [产品化服务](https://docs.apiseven.com/api7-gateway/3.9.x/api-portal/productize-services.md): 遵循本指南在 API7 企业版中创建和管理 API 产品，简化开发工作流程并确保关联服务的自动更新。 #### api-security - [设置 API 认证](https://docs.apiseven.com/api7-gateway/3.9.x/api-security/api-authentication.md): 按照本指南在 API7 企业版中设置 API 认证，通过各种认证插件确保只有授权的消费者才能访问你的 API。 - [引用 AWS Secrets Manager 中的密钥](https://docs.apiseven.com/api7-gateway/3.9.x/api-security/aws-secrets-manager.md): 按照本指南将 API7 企业版与 AWS Secrets Manager 集成，实现敏感信息的安全管理和密钥的自动轮换。 - [限制访问 API 的 IP 地址](https://docs.apiseven.com/api7-gateway/3.9.x/api-security/block-ip.md): 按照本指南在 API7 企业版中配置 IP 地址限制，通过阻止指定的 IP 地址来防止不受欢迎的用户访问你的 API。 - [在客户端和 API7 网关之间配置 mTLS](https://docs.apiseven.com/api7-gateway/3.9.x/api-security/client-mtls.md): 按照本指南在客户端和 API 网关之间配置双向 TLS (mTLS)，通过双方的相互身份验证来增强安全性。 - [引用 HashiCorp Vault 中的密钥](https://docs.apiseven.com/api7-gateway/3.9.x/api-security/hashicorp-vault.md): 按照本指南将 API7 企业版与 HashiCorp Vault 集成，实现 API 密钥和密码等敏感信息的安全存储和检索。 - [引用 Kubernetes Secret 中的密钥](https://docs.apiseven.com/api7-gateway/3.9.x/api-security/kubernetes-secret.md): 按照本指南将 API7 企业版与 Kubernetes 集成，实现 API 密钥和密码等敏感信息的安全存储和检索。 - [对日志进行数据脱敏](https://docs.apiseven.com/api7-gateway/3.9.x/api-security/mask-data.md): 按照本指南使用 API7 企业版隐藏日志中的敏感数据，确保机密信息不会在日志文件中泄露。 - [对 API 应用限流](https://docs.apiseven.com/api7-gateway/3.9.x/api-security/rate-limiting.md): 按照本指南在 API7 企业版中应用限流，控制对 API 的请求数量，并保护你的后端免受过多流量的影响。 - [在 API7 企业版和上游之间配置 mTLS](https://docs.apiseven.com/api7-gateway/3.9.x/api-security/upstream-mtls.md): 按照本指南在 API 网关和上游之间配置双向 TLS (mTLS)，通过双方的相互身份验证来增强安全性。 #### api7-mcp-server-guide - [部署 API7-MCP](https://docs.apiseven.com/api7-gateway/3.9.x/api7-mcp-server-guide/deploy-api7-mcp.md): 配置 API7-MCP，让兼容 MCP 的 AI 客户端检查 API7 企业版资源和监控数据、管理 RBAC，并发送测试流量。 #### best-practices - [API 版本控制](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/api-version-control.md): 按照本指南在 API7 企业版中实施 API 版本控制，在发生更改后也能保持部署的一致性，并在管理 API 功能时实现更平滑的回滚。 - [配置蓝绿发布](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/blue-green-deployment.md): 按照本指南在 API7 企业版中设置蓝绿发布，通过使用两个相同的环境，将应用程序更新期间的停机时间和风险降至最低。 - [代理 gRPC 流量](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/configure-grpc.md): 按照本指南配置 API7 网关以代理 gRPC 流量，使你能够使用 HTTP/2 处理高性能的远程过程调用（RPC）。 - [添加自定义插件](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/custom-plugin.md): 遵循本指南在 API7 企业版中添加自定义插件，通过使用 Lua 编程定制逻辑来扩展功能和管理 API 流量。 - [使用 LDAP 配置控制台 SSO](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/dashboard-sso/ldap.md): 按照本指南在 API7 企业版中使用 LDAP 协议配置单点登录 (SSO)，简化用户身份验证并增强安全性。 - [使用 Auth0 配置控制台 SSO](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/dashboard-sso/oidc/auth0.md): 按照本指南在 API7 企业版中使用 OIDC 协议配置基于 Auth0 的单点登录 (SSO)，简化用户身份验证并增强安全性。 - [使用 Microsoft Entra ID 配置控制台 SSO](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/dashboard-sso/oidc/azure-ad.md): 按照本指南在 API7 企业版中使用 OIDC 协议配置基于 Microsoft Entra ID (Azure AD) 的单点登录 (SSO)，简化用户身份验证并增强安全性。 - [使用 Keycloak 配置控制台单点登录 (SSO)](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/dashboard-sso/oidc/keycloak.md): 按照本指南在 API7 企业版中使用 OIDC 和 Keycloak 配置单点登录 (SSO)，从而简化用户身份验证并增强安全性。 - [使用 Microsoft Entra ID 和 SAML 配置控制台 SSO](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/dashboard-sso/saml/azure-ad.md): 按照本指南在 API7 企业版中使用 SAML 协议配置基于 Microsoft Entra ID (Azure AD) 的单点登录 (SSO)，简化用户身份验证并增强安全性。 - [使用 Okta 和 SAML 配置控制台 SSO](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/dashboard-sso/saml/okta.md): 按照本指南在 API7 企业版中使用 SAML 协议配置基于 Okta 的单点登录 (SSO)，简化用户身份验证并在控制台中启用角色映射。 - [在访问日志中脱敏敏感数据](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/data-masking-access-log.md): 了解如何在 API 网关访问日志中有效脱敏诸如电子邮件地址之类的敏感数据，以增强安全性并确保可靠的 API 管理。 - [设计自定义角色系统](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/design-custom-role-system.md): 按照本指南在 API7 企业版中设计并实现自定义角色系统，授予用户细粒度的访问权限以增强安全性和数据完整性。 - [声明式管理 API7 企业版](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/devops-adc.md): 按照本指南使用 API7 声明式 CLI（ADC）声明式地管理 API7 企业版配置，轻松与版本控制系统和 CI/CD 流水线集成。 - [有条件地禁用全局插件](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/disable-global-plugins-conditionally.md): 了解如何在 API7 企业版中有条件地禁用全局插件执行，使你可以根据特定要求灵活控制插件的执行。 - [将外部认证的用户信息转发到上游](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/forward-auth-user-info-to-upstream.md): 在使用 OpenID Connect 或 SAML Auth 等认证插件时，你可能需要将经过身份验证的用户信息传递给上游服务。这使上游应用程序能够基于用户身份实现额外的业务逻辑，例如个性化、审计和访问控制。 - [将 Kubernetes 的错误日志转发至 Splunk](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/gateway-error-log-kubernetes-splunk.md): 了解如何将部署在 Kubernetes 环境中的多个网关的错误日志转发至 Splunk，以进行集中式的日志管理。 - [执行网关健康检查探针](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/gateway-health-probe.md): 按照本指南在 API7 企业版中启用健康检查探针，通过监控上游节点的健康状况来确保网关的稳定性和可靠性。 - [使用网关组在多环境中管理服务](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/manage-services-in-multi-environments.md): 了解如何使用 API7 企业版中的网关组在多个环境中管理服务，从而优化工作流程并减少 API 运维中的错误。 - [使用 Token 集成 GitOps 工作流](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/manage-token.md): 按照本指南在 API7 企业版中实施基于 Token 的身份验证，实现与 GitOps 工作流的无缝集成并增强安全性。 - [代理 TCP 流量](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/proxy-tcp-traffic.md): 按照本指南配置 API7 网关以处理 TCP 和 UDP 流量，从而为 MySQL 等各种后端服务启用传输层 (四层) 代理。 - [设置路由优先级和匹配条件 (Ingress Controller)](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/route-priority-matching-conditions.md): 遵循本指南使用 Ingress Controller 配置路由优先级和高级匹配条件，以实现更细粒度的 API 管理。 - [使用 Okta 配置 SCIM 账号同步](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/scim/okta.md): 按照本指南在 API7 企业版中配置基于 Okta 的 SCIM 账号同步，实现身份提供商和 API7 控制台之间的用户自动同步。 - [使用服务发现配置上游](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/service-discovery.md): 按照本指南在 API7 企业版中配置服务发现机制，以支持动态探测上游节点并增强 API 管理的灵活性。 - [优化遥测数据传输](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/telemetry-compression.md): 按照本指南配置从 API7 企业版数据面（DP）到控制面（CP）的遥测数据压缩，以提高网络性能并降低 CPU 使用率。 - [确保上游高可用性](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/upstream-ha.md): 按照本指南在 API7 企业版中通过添加多个上游节点、修改负载均衡类型以及启用健康检查来确保上游的高可用性。 - [验证 API7 镜像签名](https://docs.apiseven.com/api7-gateway/3.9.x/best-practices/verify-api7-image-signatures.md): 遵循本指南使用 Cosign 验证 API7 Docker 镜像签名，确保软件供应链中镜像的真实性和完整性。 #### configure-and-manage - [在 AWS EKS 上运行基准](https://docs.apiseven.com/api7-gateway/3.9.x/configure-and-manage/benchmark-on-aws-eks.md): 在 AWS EKS 上重现已发布的 API7 网关性能基准。演练涵盖 EKS 集群设置、三个独立节点组、Helm 安装、NGINX 上游和 wrk2 部署以及运行完整的场景套件。 - [API7 网关控制面配置参考](https://docs.apiseven.com/api7-gateway/3.9.x/configure-and-manage/configure-control-plane.md): API7 网关控制面的详细配置参考，涵盖控制台和 DP Manager 配置文件。 - [API7 网关数据面配置参考](https://docs.apiseven.com/api7-gateway/3.9.x/configure-and-manage/configure-data-plane.md): API7 网关数据面的详细配置参考，基于 config-default.yaml 结构。 - [数据面弹性](https://docs.apiseven.com/api7-gateway/3.9.x/configure-and-manage/data-plane-resilience.md): 为 API7 网关数据面节点配置备用存储，使其在控制面长时间中断时仍能重启并继续运行。 - [API7 网关多可用区部署](https://docs.apiseven.com/api7-gateway/3.9.x/configure-and-manage/deployment-scenarios/multi-az-deployment.md): 用于跨多个可用区部署 API7 网关的配置和架构，以实现高可用性和容错能力。 - [多区域部署模式](https://docs.apiseven.com/api7-gateway/3.9.x/configure-and-manage/deployment-scenarios/multi-region-deployment.md): 跨多个地理区域部署 API7 网关以实现全球覆盖和灾难恢复的架构和注意事项。 - [数据面高可用性](https://docs.apiseven.com/api7-gateway/3.9.x/configure-and-manage/high-availability-data-plane.md): 设计具有多个节点、健康检查和负载均衡器故障转移的高可用 API7 网关数据面。 - [许可证管理](https://docs.apiseven.com/api7-gateway/3.9.x/configure-and-manage/license-management.md): 管理 API7 网关许可证，了解核心数额度和许可证状态，并配置许可证文件路径以实现自动化部署。 - [性能基准](https://docs.apiseven.com/api7-gateway/3.9.x/configure-and-manage/performance-benchmark.md): 了解 API7 网关在 AWS EKS 和单主机环境中的性能基准结果，以及复现基准测试的方法和优化建议。 - [生产最佳实践](https://docs.apiseven.com/api7-gateway/3.9.x/configure-and-manage/production-best-practices.md): 在生产中管理 API7 网关的操作最佳实践，包括 GitOps、变更管理和灾难恢复。 - [在生产环境中运行](https://docs.apiseven.com/api7-gateway/3.9.x/configure-and-manage/run-in-production.md): API7 网关的上线前检查清单和部署指南，用于确保生产环境稳定且安全。 - [扩缩容数据面](https://docs.apiseven.com/api7-gateway/3.9.x/configure-and-manage/scale-data-plane.md): 水平扩展 API7 网关数据面节点以提高吞吐量并为高可用性部署做好准备。 - [共享内存容量规划](https://docs.apiseven.com/api7-gateway/3.9.x/configure-and-manage/shared-dict-sizing.md): 根据部署规模为 API7 Gateway 的指标、服务发现、开发者门户和链路追踪等共享内存合理分配容量，避免溢出导致数据丢失。 #### deployment - [使用 Docker Compose 部署](https://docs.apiseven.com/api7-gateway/3.9.x/deployment/docker.md): 本指南提供了使用 Docker Compose 部署 API7 企业版控制面和数据面的步骤，以实现高效的 API 管理。 - [在 Kubernetes 上部署 API7 Ingress Controller](https://docs.apiseven.com/api7-gateway/3.9.x/deployment/ingress-controller.md): 了解如何在 Kubernetes 上部署 API7 网关和 Ingress Controller，从而实现声明式的 API 管理。 - [在 OpenShift 上安装 API7 Ingress Controller](https://docs.apiseven.com/api7-gateway/3.9.x/deployment/ingress-controller-openshift.md): 按照本指南在 OpenShift 集群上部署 API7 Ingress Controller，确保为你的环境进行正确配置和设置。 - [在 OpenShift 上安装 API7 企业版](https://docs.apiseven.com/api7-gateway/3.9.x/deployment/openshift.md): 按照本指南在 OpenShift 集群上部署 API7 企业版，确保为你的环境进行正确的配置和设置。 #### enterprise-features - [告警和联系人](https://docs.apiseven.com/api7-gateway/3.9.x/enterprise-features/alerts-and-contact-points.md): 了解 API7 网关中的告警和联系人，以及如何监控异常并及时发送通知。 - [控制台单点登录](https://docs.apiseven.com/api7-gateway/3.9.x/enterprise-features/dashboard-sso.md): 了解 API7 网关中的单点登录（SSO），使用现有凭证进行身份认证，轻松访问控制台。 - [高可用性](https://docs.apiseven.com/api7-gateway/3.9.x/enterprise-features/high-availability.md): 了解 API7 网关中的高可用性，为关键业务应用持续提供可靠服务。 - [安全加固](https://docs.apiseven.com/api7-gateway/3.9.x/enterprise-features/security-hardening.md): 了解 API7 网关中的安全加固能力，保护 API 基础设施免受威胁和漏洞影响。 #### getting-started - [新增网关组](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/add-gateway-group.md): 按照本教程学习如何在 API7 企业版中新增网关组，从而实现对 API 网关实例的有效管理和组织。 - [新增网关实例](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/add-gateway-instance.md): 按照本教程了解如何将网关实例新增到你的 API7 企业版网关组中，确保高效的路由和 API 处理。 - [使用审计日志追踪操作员活动](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/audit-logging.md): 按照本教程在 API7 企业版中使用审计日志功能，实现对用户活动的详细追踪，并提升安全性和合规性。 - [配置金丝雀流量转移](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/canary-upstream.md): 按照本教程在 API7 企业版中配置金丝雀流量转移，通过逐步路由流量来安全地测试新的上游。 - [创建自定义角色](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/create-custom-role.md): 按照本教程在 API7 企业版中创建自定义角色，从而实现针对特定需求量身定制的细粒度权限管理。 - [安装 API7 企业版](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/install-api7-ee.md): 按照本教程在 Docker 上安装 API7 企业版，包括用于管理 API 网关和确保无缝设置的基本组件。 - [配置 Kubernetes 服务发现](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/k8s-service-discovery.md): 按照本指南在 API7 企业版中配置 Kubernetes 服务发现，以支持动态探测 Kubernetes 集群中的上游节点。 - [发布你的第一个 API](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/launch-your-first-api.md): 学习如何在 API7 企业版上发布并验证你的第一个 API，包括创建已发布的服务、路由，以及通过 HTTP 请求进行测试。 - [深入了解 API7 产品和 APISIX](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/learn-more.md): 了解 API7 产品系列、API7 企业版与 Apache APISIX 的关系，以及它们如何融入你的 API 管理策略。 - [续订许可证](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/license.md): 了解如何获取和续订 API7 企业版许可证，以确保你可以持续访问各项功能和服务。 - [发布服务版本](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/publish-service.md): 按照本教程在 API7 企业版中发布服务版本，从而实现对跨不同网关组的 API 进行有效的版本控制和管理。 - [快速开始](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/quick-start.md): 使用 Docker Compose 在本地运行 API7 网关，并在 10 分钟内代理首个 API 请求。 - [更新用户角色](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/rbac.md): 按照本教程在 API7 企业版中管理基于角色的访问控制（RBAC），通过角色和权限策略简化用户权限管理。 - [回滚服务](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/rollback-service.md): 按照本教程在 API7 企业版中将服务回滚到以前的版本，以便在较新版本出现问题时能够快速恢复。 - [在网关组之间同步服务](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/sync-service.md): 按照本教程在 API7 企业版中的网关组之间同步已发布的服务版本，从而实现跨环境的平滑更新。 - [教程：通过插件代理和管理 API 请求](https://docs.apiseven.com/api7-gateway/3.9.x/getting-started/tutorial-proxying-api-requests.md): 通过动手实践，学习代理 API 请求、使用 `key-auth` 插件添加身份认证，以及启用 `limit-count` 插件实施限流。 #### high-availability - [数据面弹性概览](https://docs.apiseven.com/api7-gateway/3.9.x/high-availability/cp-outage-overview.md): 了解 API7 企业版如何通过确保网关节点在控制面（CP）不可用时继续运行和提供服务，从而实现数据面弹性。 - [使用 AWS S3 实现数据面弹性](https://docs.apiseven.com/api7-gateway/3.9.x/high-availability/cp-outage/dp-resilience-aws-s3.md): 在 API7 企业版中通过带有 IAM 角色或访问密钥的 AWS S3 配置数据面弹性，以便在控制面不可用时保持网关运行。 - [使用 Azure Blob Storage 实现数据面高可用](https://docs.apiseven.com/api7-gateway/3.9.x/high-availability/cp-outage/dp-resilience-azure-blob.md): 在 API7 企业版中配置基于 Azure Blob Storage 的数据面（DP）高可用性。你可以使用 Workload Identity 或访问密钥进行认证，确保在控制面（CP）故障期间网关能够继续运行。 - [高可用安装](https://docs.apiseven.com/api7-gateway/3.9.x/high-availability/high-availability-installation.md): 遵循本指南安装 API7 网关及其组件以实现高可用，防止单点故障。 - [API7 高可用性概览](https://docs.apiseven.com/api7-gateway/3.9.x/high-availability/overview.md): 了解 API7 中高可用性 (HA) 的概念，确保系统中的连续服务和故障恢复能力。 - [准备高可用环境](https://docs.apiseven.com/api7-gateway/3.9.x/high-availability/prepare-for-high-availability.md): 了解如何为 API7 企业版高可用部署做准备，包括前置条件和配置要求。 #### how-to-guides - [配置数据脱敏](https://docs.apiseven.com/api7-gateway/3.9.x/how-to-guides/api-security/data-masking.md): 使用 data-mask 插件，在请求数据写入访问日志和日志插件输出前对敏感字段进行遮盖、替换或移除，帮助满足 GDPR、HIPAA 和 PCI-DSS 要求。 - [配置就绪和存活探针](https://docs.apiseven.com/api7-gateway/3.9.x/how-to-guides/ops/configure-readiness-probe.md): 为 Kubernetes、Docker 和其他非 Helm 部署中的 API7 网关数据面配置就绪和存活检查。 - [创建自定义角色](https://docs.apiseven.com/api7-gateway/3.9.x/how-to-guides/ops/create-custom-role.md): 通过定义权限策略、将其附加到角色并将角色分配给用户，在 API7 网关中创建自定义角色。 - [设计自定义角色体系](https://docs.apiseven.com/api7-gateway/3.9.x/how-to-guides/ops/design-custom-role-system.md): 通过组合角色、权限策略、标签和权限边界，在 API7 网关中设计可扩展的自定义角色体系。 - [管理网关组](https://docs.apiseven.com/api7-gateway/3.9.x/how-to-guides/ops/multi-gateway-group.md): 了解如何创建和管理多个网关组，以便按环境或团队组织和隔离 API 流量。 - [配置密钥管理](https://docs.apiseven.com/api7-gateway/3.9.x/how-to-guides/ops/secret-manager.md): 了解如何配置密钥提供方，并在 API7 企业版中引用外部密钥，避免在网关资源中硬编码敏感值。 - [实施灰度发布](https://docs.apiseven.com/api7-gateway/3.9.x/how-to-guides/traffic-management/canary-release.md): 了解如何使用 traffic-split 插件逐步将流量迁移到新版后端服务。 - [配置上游健康检查](https://docs.apiseven.com/api7-gateway/3.9.x/how-to-guides/traffic-management/health-check.md): 了解如何为上游服务配置主动和被动健康检查，以确保高可用。 - [改写代理请求](https://docs.apiseven.com/api7-gateway/3.9.x/how-to-guides/traffic-management/proxy-rewrite.md): 了解如何在将请求代理到上游服务前修改请求 URI、方法和请求头。 - [配置限流](https://docs.apiseven.com/api7-gateway/3.9.x/how-to-guides/traffic-management/rate-limiting.md): 了解如何为 API 配置简单和高级限流，以防止滥用并确保公平使用。 #### install - [部署高可用环境](https://docs.apiseven.com/api7-gateway/3.9.x/install/deploy-high-availability.md): 以高可用配置部署 API7 网关控制面和数据面，消除单点故障。 - [在 Kubernetes 上部署 API7 企业版](https://docs.apiseven.com/api7-gateway/3.9.x/install/deploy-on-kubernetes.md): 使用 Helm 在 Kubernetes 上部署 API7 企业版，包括控制面安装、使用 mTLS 配置数据面，以及 AWS EKS、GCP GKE 和 Azure AKS 专用指南。 - [在 OpenShift 上部署](https://docs.apiseven.com/api7-gateway/3.9.x/install/deploy-on-openshift.md): 使用正确的安全上下文约束（SCC）、服务账号和 Helm Chart 配置，在 Red Hat OpenShift 上部署 API7 网关。 - [使用 Docker Compose 部署](https://docs.apiseven.com/api7-gateway/3.9.x/install/deploy-with-docker-compose.md): 使用 Docker Compose 在本地部署 API7 企业版。该开发和测试环境会启动包含 PostgreSQL、Prometheus、Jaeger、集成控制台和 DP Manager 的控制面，然后通过控制台生成的 Docker 命令添加数据面网关。 - [安装常见问题](https://docs.apiseven.com/api7-gateway/3.9.x/install/installation-faq.md): 安装过程中的常见问题和故障排查方法。 - [支持的版本和互操作性](https://docs.apiseven.com/api7-gateway/3.9.x/install/supported-versions-and-interoperability.md): API7 网关组件和基础设施的版本兼容性矩阵。 - [系统要求](https://docs.apiseven.com/api7-gateway/3.9.x/install/system-requirements.md): 安装 API7 企业版所需的硬件、操作系统和网络要求。 #### introduction 探索 API7 企业版，这是一个基于 Apache APISIX 构建的 API 网关，专为企业需求量身定制，提供全生命周期的 API 管理。 - [概览](https://docs.apiseven.com/api7-gateway/3.9.x/introduction.md): 探索 API7 企业版，这是一个基于 Apache APISIX 构建的 API 网关，专为企业需求量身定制，提供全生命周期的 API 管理。 - [架构](https://docs.apiseven.com/api7-gateway/3.9.x/introduction/architecture.md): 探索 API7 企业版的架构，这是一个基于 Apache APISIX 的云原生 API 网关，具有可扩展的数据平面和控制平面，可满足企业需求。 #### key-concepts - [API 门户](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/api-portal.md): API7 门户（API Portal）是一个集中式的在线平台，充当 API 提供者（API Providers）与开发者（Developers）之间的桥梁。 - [API 产品](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/api-products.md): 了解 API7 企业版中的 API 产品，它们将 API 捆绑在一起，以简化使用、管理，并为开发者提供有针对性的服务。 - [架构](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/architecture.md): 深入了解 API7 企业版控制面与数据面解耦的架构。 - [证书](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/certificates.md): 了解 API7 企业版如何支持 TLS 和 mTLS，以确保客户端、API 网关和服务之间的安全通信和信任。 - [消费者](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/consumers.md): 探索 API7 企业版中的消费者管理，重点关注身份验证、访问控制和安全的 API 请求处理。 - [消费者和凭证](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/consumers-and-credentials.md): 使用消费者和凭证进行身份管理与身份认证。 - [开发者](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/developers.md): 了解开发者在 API7 企业版中的角色，使他们能够通过 API 门户有效地发现、学习和集成 API。 - [网关组与网关实例](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/gateway-groups.md): 了解 API7 企业版中的网关组如何通过组合多个网关实例来进行有效的扩展，从而简化管理。 - [概览](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/overview.md): 探索 API7 企业版的架构，以实现高效的 API 请求管理，从而提升现代应用程序的性能、安全性和可扩展性。 - [插件](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/plugins.md): 了解 API7 企业版中如何通过插件扩展功能，满足你在流量管理、安全性、请求转换等方面的定制化需求。 - [角色与权限策略](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/roles-and-permission-policies.md): 了解 API7 企业版中的角色和权限策略，实现细粒度的访问控制和用户管理，确保 API 操作的安全性。 - [路由](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/routes.md): 了解 API7 企业版路由如何管理 HTTP 请求和响应，优化到后端服务的流量，从而实现无缝的 API 性能。 - [密钥](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/secrets.md): 了解如何在 API7 企业版中使用密钥对象和提供程序安全地管理敏感信息，以增强 API 数据保护。 - [服务发现](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/service-discovery.md): API7 网关中的动态上游解析，无需硬编码 IP，即可从 Kubernetes Service、Nacos 和 Consul 注册中心自动发现后端端点。 - [服务](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/services.md): 探索 API7 企业版中的服务，了解如何通过强大的路由、出色的可扩展性以及对后端应用性能的增强来简化 API 管理。 - [服务与路由](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/services-and-routes.md): 了解如何使用服务与路由对 API 流量进行分组和路由。 - [SNI](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/snis.md): 探索 API7 企业版如何使用服务器名称指示（SNI）允许多个主机名共享 SSL 证书，从而提高安全性和效率。 - [SSL 证书](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/ssl-certificates.md): 了解 API7 网关如何管理 SSL/TLS 证书和终止安全连接。 - [四层路由](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/stream-routes.md): 了解 API7 企业版中的四层路由，它们支持管理 TCP/UDP 流量并对服务进行细粒度的访问控制。 - [上游](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/upstreams.md): 了解 API7 企业版中的上游，它们将后端服务分组以实现高效路由、负载均衡和增强 API 性能。 - [上游与负载均衡](https://docs.apiseven.com/api7-gateway/3.9.x/key-concepts/upstreams-and-load-balancing.md): 后端目标定义，包括负载均衡算法和健康检查。 #### observability - [配置告警](https://docs.apiseven.com/api7-gateway/3.9.x/observability/alerts.md): 配置 API7 网关告警策略和联系人，当网关离线、证书过期或错误率超过阈值时通过邮件或 Webhook 接收通知。 - [在访问日志中包含消费者标签](https://docs.apiseven.com/api7-gateway/3.9.x/observability/consumer-label-based-logging.md): 在 API7 网关访问日志中包含消费者标签，以便按消费者跟踪和分析流量。 - [使用调试会话捕获请求链路](https://docs.apiseven.com/api7-gateway/3.9.x/observability/debug-sessions.md): 了解网关处理单个请求时的完整行为，包括插件执行顺序、耗时和日志。你可以按需捕获，也可以在告警触发时自动捕获。 - [将 Kubernetes 错误日志发送到 Splunk](https://docs.apiseven.com/api7-gateway/3.9.x/observability/kubernetes-error-log-forwarding.md): 使用 Splunk OpenTelemetry Collector，将 Kubernetes 中 API7 网关容器的错误日志转发到 Splunk。 - [配置集中式日志记录](https://docs.apiseven.com/api7-gateway/3.9.x/observability/logging.md): 了解 API7 网关生成的访问日志和错误日志，配置格式与详细程度，并将日志转发到集中式日志管理系统。 - [监控指标](https://docs.apiseven.com/api7-gateway/3.9.x/observability/metrics.md): 通过控制台内置监控页面或抓取数据面公开的 Prometheus 端点，监控 API7 网关指标。 - [将访问日志发送到 Splunk](https://docs.apiseven.com/api7-gateway/3.9.x/observability/splunk-integration.md): 使用 HTTP Event Collector（HEC）日志插件，将 API7 网关访问日志发送到 Splunk。 - [配置分布式追踪](https://docs.apiseven.com/api7-gateway/3.9.x/observability/tracing.md): 使用 OpenTelemetry 插件在 API7 网关中配置分布式追踪、OTLP Collector、采样策略和路由跨度，以可视化请求流并分析延迟瓶颈。 #### overview 了解 API7 网关 3.9.x 版本的架构、功能和部署模型。 - [API7 网关](https://docs.apiseven.com/api7-gateway/3.9.x/overview.md): 了解 API7 网关 3.9.x 版本的架构、功能和部署模型。 #### performance - [准备测试环境 (AWS EKS)](https://docs.apiseven.com/api7-gateway/3.9.x/performance/aws-eks.md): 在 AWS EKS 上搭建 API7 企业版性能测试环境，包括配置和资源分配。 - [建立性能基准](https://docs.apiseven.com/api7-gateway/3.9.x/performance/benchmark.md): 了解如何为 API7 企业版 API 网关建立性能基准，以确保准确评估其能力。 - [性能测试基准](https://docs.apiseven.com/api7-gateway/3.9.x/performance/performance-testing.md): 探索测试方法和结果，以评估 API7 企业版在不同负载条件下的性能。 #### production - [自动扩缩容 API7 Gateway (K8s)](https://docs.apiseven.com/api7-gateway/3.9.x/production/scaling/autoscale-api7-gateway.md): 了解如何使用水平 Pod 自动扩缩容（HPA）在 Kubernetes 上对 API7 Gateway 进行自动扩缩容，以在不同的流量负载下保持一致的 API 性能。 #### reference CLI 工具 - [API 参考](https://docs.apiseven.com/api7-gateway/3.9.x/reference.md): CLI 工具 - [ADC 参考](https://docs.apiseven.com/api7-gateway/3.9.x/reference/adc.md): 使用 API 声明式 CLI（ADC）以声明式方式管理 API7 企业版网关配置。 - [告警变量与模板](https://docs.apiseven.com/api7-gateway/3.9.x/reference/alert-template.md): 在 API7 企业版中使用预定义变量自定义告警通知，从而在告警消息和电子邮件中实现动态内容。 - [构建 API 端点](https://docs.apiseven.com/api7-gateway/3.9.x/reference/api-implementation/build-api-endpoints.md): API 端点为您的 API 提供实际的业务逻辑和数据。在将 API 与 API7 企业版集成之前，您需要开发并部署它们。 - [注解 (Annotations)](https://docs.apiseven.com/api7-gateway/3.9.x/reference/api7-ingress-controller/annotation.md): 了解注解如何在 API7 Ingress Controller 中扩展 Kubernetes Ingress 和 IngressClass 资源的功能，以配置路由、安全性和网关行为。 - [自定义资源定义 API 参考](https://docs.apiseven.com/api7-gateway/3.9.x/reference/api7-ingress-controller/api-reference.md): 浏览 API7 Ingress Controller 支持的自定义资源定义 (CRD) 的详细参考文档。 - [配置文件](https://docs.apiseven.com/api7-gateway/3.9.x/reference/api7-ingress-controller/configuration-file.md): 使用 config.yaml 文件配置 API7 Ingress Controller，包括日志设置、领导者选举、指标和同步行为等配置。 - [配置示例](https://docs.apiseven.com/api7-gateway/3.9.x/reference/api7-ingress-controller/examples.md): 探索展示 API7 Ingress Controller 配置的各种示例，以帮助你根据你的环境有效地调整设置。 - [Ingress 与 Gateway API 支持](https://docs.apiseven.com/api7-gateway/3.9.x/reference/api7-ingress-controller/ingress-and-gateway-api-support.md): 了解 API7 Ingress Controller 支持的 Gateway API 和 Ingress 资源及其当前功能。 - [审批变量与模板](https://docs.apiseven.com/api7-gateway/3.9.x/reference/approval-variables.md): 了解如何在 API7 企业版中使用审批变量，为审批通知和模板创建动态内容。 - [内置变量](https://docs.apiseven.com/api7-gateway/3.9.x/reference/built-in-variables.md): 了解 API7 网关中可用的内置变量，包括 NGINX、APISIX 和自定义变量，这些变量可用于路由匹配、日志自定义和插件配置。 - [配置文件](https://docs.apiseven.com/api7-gateway/3.9.x/reference/configuration.md): 了解 API7 企业版中使用的配置文件，包括用于有效管理设置的默认和用户定义文件。 - [设计 API](https://docs.apiseven.com/api7-gateway/3.9.x/reference/design-apis.md): 作为工程师，您需要根据业务需求明确 API 的功能目的，然后将业务语言转化为技术语言。精心设计的 API 的好处包括改善开发者体验、加快文档编写速度并提高 API 的采用率。 - [环境变量](https://docs.apiseven.com/api7-gateway/3.9.x/reference/environment-variables.md): 探索在 API7 企业版中使用环境变量来配置消费者凭证、SSL 证书和插件。 - [API7 表达式](https://docs.apiseven.com/api7-gateway/3.9.x/reference/expressions.md): 了解如何在 API7 企业版中使用表达式进行路由匹配、请求过滤和配置中的条件逻辑。 - [安全加固参考](https://docs.apiseven.com/api7-gateway/3.9.x/reference/hardening.md): 了解在 API7 企业版中保护敏感信息的做法，包括存储、加密和通信实践，以防御各种威胁。 - [从控制台获取令牌](https://docs.apiseven.com/api7-gateway/3.9.x/reference/obtain-dashboard-token.md): 在 API7 控制台中创建令牌，并将其用于 API7 网关 Admin API 和 ADC 身份认证。 - [OpenAPI 转换器参考](https://docs.apiseven.com/api7-gateway/3.9.x/reference/openapi-adc.md): 了解如何使用支持的扩展和自定义属性将 OpenAPI 规范转换为 ADC 配置。 - [权限策略的操作与资源](https://docs.apiseven.com/api7-gateway/3.9.x/reference/permission-policy-action-and-resource.md): 查阅 API7 企业版权限策略框架中可用的操作和资源，以实现细粒度的访问控制。 - [权限策略示例](https://docs.apiseven.com/api7-gateway/3.9.x/reference/permission-policy-examples.md): 查看 API7 企业版中的权限策略示例，以在你的环境中有效地创建和管理访问控制。 #### release-notes - [更新日志](https://docs.apiseven.com/api7-gateway/3.9.x/release-notes.md) #### scalability - [在 Kubernetes 上自动扩缩容数据面](https://docs.apiseven.com/api7-gateway/3.9.x/scalability/autoscale-on-kubernetes.md): 使用 Kubernetes 的 Horizontal Pod Autoscaler（HPA）自动扩缩容 API7 网关数据面 Pod，以应对流量变化。 #### security-and-compliance - [访问控制列表（ACL）](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/access-control-lists.md): 使用 API7 网关的 `consumer-restriction` 插件限制 API 访问。按消费者名称、消费者组 ID、服务 ID 或路由 ID 配置允许列表和拒绝列表，实现细粒度安全控制。 - [审计日志](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/audit-logs.md): 通过详细的审计日志跟踪 API7 控制面中的所有管理变更。了解如何查看、管理和导出审计记录，满足安全与合规要求。 - [控制面与数据面之间的双向 TLS](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/authenticate/mutual-tls-cp-dp.md): 了解 API7 网关如何使用基于 PKI 的可靠双向 TLS（mTLS）模型，保护控制面与数据面之间的所有通信。 - [为控制台配置 SCIM 预配](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/authenticate/scim.md): 使用受支持的身份提供商，为 API7 控制台配置 SCIM 用户预配。 - [使用 Microsoft Entra ID 进行 SCIM 预配](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/authenticate/scim-microsoft-entra-id.md): 为 API7 控制台配置 Microsoft Entra ID SCIM 预配。 - [使用 Okta 进行 SCIM 预配](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/authenticate/scim-okta.md): 为 API7 控制台配置 Okta SCIM 预配。 - [控制面 IP 限制](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/ip-restrictions-control-plane.md): 使用控制面内置 IP 允许列表限制可访问 API7 控制面（控制台和 Admin API）的客户端 IP 地址，并结合网络级控制实现纵深防御。 - [OAuth 2.0 和 OIDC](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/oauth-oidc.md): 使用现代化的令牌身份认证保护 API，并了解如何将 API7 网关与 Okta、Keycloak 等 OAuth 2.0 和 OpenID Connect（OIDC）提供商集成。 - [开源许可证](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/open-source-licenses.md): 了解 API7 网关对开源软件和许可证合规的承诺，以及所使用的主要开源组件及其许可证。 - [安全与合规概览](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/overview.md): 了解 API7 网关如何通过身份认证、授权、加密和审计等完整的安全与合规能力保护 API。 - [权限策略和权限边界](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/permission-policies-and-boundaries.md): 使用原生 JSON 文档格式在 API7 网关中编写权限策略。了解 `statement` 结构、允许的操作、ARN 风格资源、基于标签的条件，以及权限边界如何限制用户的最大权限范围。 - [基于角色的访问控制（RBAC）](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/role-based-access-control.md): 使用基于角色的访问控制管理用户对 API7 网关控制面的访问。为用户分配角色、挂载权限策略，并在网关组之间实施最小权限访问。 - [安全凭证管理](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/secure-credentials.md): 使用 API7 网关安全凭证管理保护敏感信息。了解如何管理 SSL 证书，以及如何与 HashiCorp Vault 等外部密钥管理器集成。 - [控制台单点登录（SSO）](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/sso-dashboard.md): 使用单点登录（SSO）集中管理 API7 控制台用户访问。支持 OIDC、SAML、LDAP 和 CAS 协议，并可自动映射角色。 - [使用 LDAP 实现单点登录](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/sso-ldap.md): 使用 LDAP 为 API7 控制台配置单点登录（SSO），使用户能够使用现有目录服务凭证认证。 - [使用 OIDC 配置 SSO](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/sso-oidc.md): 使用 OpenID Connect（OIDC）为 API7 控制台配置单点登录（SSO），并提供 Keycloak、Microsoft Entra ID 和 Auth0 的提供商专用配置指引。 - [使用 SAML 配置 SSO](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/sso-saml.md): 使用 SAML 2.0 为 API7 控制台配置单点登录（SSO），并提供 Microsoft Entra ID 和 Okta 的提供商专用配置指引。 - [信任中心](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/trust-center.md): API7 信任中心集中提供所有安全与合规信息，包括认证、安全报告和最佳实践指南。 - [验证镜像签名](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/verify-image-signatures.md): 使用 Cosign 和基于 OIDC 的无密钥验证来验证 API7 企业版容器镜像签名，确认每个镜像均由 API7.ai 构建和签名，以保护软件供应链。 - [漏洞扫描](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/vulnerability-scanning.md): 了解 API7.ai 针对 API7 网关实施的安全测试和漏洞扫描实践，包括 CVE 报告和补丁流程。 - [Web 应用防火墙（WAF）](https://docs.apiseven.com/api7-gateway/3.9.x/security-and-compliance/web-application-firewall.md): 了解何时将 Web 应用防火墙与 API7 网关结合使用、WAF 在安全模型中的作用，以及当前文档提供的集成方式。 #### tools - [CLI 工具](https://docs.apiseven.com/api7-gateway/3.9.x/tools/cli-tools.md) - [声明式 API](https://docs.apiseven.com/api7-gateway/3.9.x/tools/declarative-api.md) #### upgrade-guides - [备份与恢复](https://docs.apiseven.com/api7-gateway/3.9.x/upgrade-guides/backup-and-restore.md): 了解如何备份和恢复你的 API7 企业版数据，包含数据库备份、声明式配置备份和数据恢复过程的逐步说明。 - [历史重大变更](https://docs.apiseven.com/api7-gateway/3.9.x/upgrade-guides/breaking-changes.md): 了解 API7 企业版各个版本中的重大变更，包括已废弃的功能和升级注意事项，以避免服务中断。 - [API 网关集群迁移](https://docs.apiseven.com/api7-gateway/3.9.x/upgrade-guides/cluster-migration.md): 一份详细的分步指南，旨在帮助你在零停机时间的情况下，将 API7 API 网关部署迁移至新集群。 - [双集群升级](https://docs.apiseven.com/api7-gateway/3.9.x/upgrade-guides/dual-cluster.md): 逐步执行 API7 企业版双集群升级的指南，涵盖新集群部署、流量切换和回滚过程。 - [就地升级](https://docs.apiseven.com/api7-gateway/3.9.x/upgrade-guides/in-place.md): 逐步执行 API7 企业版控制平面就地升级的指南，涵盖数据库重用、配置更新和验证过程。 - [滚动升级](https://docs.apiseven.com/api7-gateway/3.9.x/upgrade-guides/rolling-upgrade.md): 逐步执行 API7 企业版数据平面节点滚动升级的指南，在维持 API 请求处理和服务连续性的同时确保零停机时间。 - [升级至 API7 企业版 3.x.x](https://docs.apiseven.com/api7-gateway/3.9.x/upgrade-guides/upgrade.md): API7 企业版升级的综合指南，涵盖控制面原地升级、数据面滚动升级、数据备份及稳定性注意事项。 ### ai-agent-skills 使用 Claude Code、Cursor 等 AI 编程 Agent，通过自然语言配置和管理 API7 企业版网关。 - [API7 网关 AI Agent Skills](https://docs.apiseven.com/api7-gateway/ai-agent-skills.md): 使用 Claude Code、Cursor 等 AI 编程 Agent，通过自然语言配置和管理 API7 企业版网关。 #### a7-persona-developer 面向使用 a7 CLI 在 API7 企业版中构建和测试 API 的 API 开发者角色 Skill，提供基于服务的 API 设计、路由配置、插件配置以及本地到云端开发工作流的决策框架。 - [API7 网关 AI Agent Skill：开发者角色](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-persona-developer.md): 面向使用 a7 CLI 在 API7 企业版中构建和测试 API 的 API 开发者角色 Skill，提供基于服务的 API 设计、路由配置、插件配置以及本地到云端开发工作流的决策框架。 #### a7-persona-operator 面向使用 a7 CLI 管理 API7 企业版实例的平台运维人员和 DevOps 工程师角色 Skill，提供网关组、企业版基于角色的访问控制（RBAC）、复杂部署、故障排查和灾难恢复的决策框架。 - [API7 网关 AI Agent Skill：运维角色](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-persona-operator.md): 面向使用 a7 CLI 管理 API7 企业版实例的平台运维人员和 DevOps 工程师角色 Skill，提供网关组、企业版基于角色的访问控制（RBAC）、复杂部署、故障排查和灾难恢复的决策框架。 #### a7-plugin-ai-content-moderation 用于通过 a7 CLI 配置 API7 企业版 AI 内容审核插件的 Skill，涵盖 ai-aws-content-moderation（AWS Comprehend，仅请求）和 ai-aliyun-content-moderation（阿里云，请求与响应并支持流式传输）、毒性阈值、类别过滤以及与 ai-proxy 的集成。 - [API7 网关 AI Agent Skill：AI 内容审核插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-ai-content-moderation.md): 用于通过 a7 CLI 配置 API7 企业版 AI 内容审核插件的 Skill，涵盖 ai-aws-content-moderation（AWS Comprehend，仅请求）和 ai-aliyun-content-moderation（阿里云，请求与响应并支持流式传输）、毒性阈值、类别过滤以及与 ai-proxy 的集成。 #### a7-plugin-ai-prompt-decorator 用于通过 a7 CLI 配置 API7 企业版 ai-prompt-decorator 插件的 Skill，涵盖向 LLM 请求添加系统、用户和助手消息前缀或后缀、设置对话上下文以及强制执行安全指南。 - [API7 网关 AI Agent Skill：ai-prompt-decorator 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-ai-prompt-decorator.md): 用于通过 a7 CLI 配置 API7 企业版 ai-prompt-decorator 插件的 Skill，涵盖向 LLM 请求添加系统、用户和助手消息前缀或后缀、设置对话上下文以及强制执行安全指南。 #### a7-plugin-ai-prompt-template 用于通过 a7 CLI 配置 API7 企业版 ai-prompt-template 插件的 Skill，涵盖定义带变量占位符的可复用提示词模板、强制执行提示词结构，以及与 ai-proxy 组合构建完整的 AI 网关流水线。 - [API7 网关 AI Agent Skill：ai-prompt-template 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-ai-prompt-template.md): 用于通过 a7 CLI 配置 API7 企业版 ai-prompt-template 插件的 Skill，涵盖定义带变量占位符的可复用提示词模板、强制执行提示词结构，以及与 ai-proxy 组合构建完整的 AI 网关流水线。 #### a7-plugin-ai-proxy 用于通过 a7 CLI 配置 API7 企业版 ai-proxy 插件的 Skill，涵盖将请求代理到模型服务提供方（OpenAI、Azure OpenAI、DeepSeek、Anthropic、Gemini、Vertex AI 等）、按服务提供方配置身份认证、模型、流式传输、日志以及路由和服务用法。 - [API7 网关 AI Agent Skill：ai-proxy 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-ai-proxy.md): 用于通过 a7 CLI 配置 API7 企业版 ai-proxy 插件的 Skill，涵盖将请求代理到模型服务提供方（OpenAI、Azure OpenAI、DeepSeek、Anthropic、Gemini、Vertex AI 等）、按服务提供方配置身份认证、模型、流式传输、日志以及路由和服务用法。 #### a7-plugin-basic-auth 用于通过 a7 CLI 配置 API7 企业版 basic-auth 插件的 Skill，涵盖路由上的 HTTP Basic Authentication、带用户名和密码的消费者凭证关联、hide_credentials、匿名消费者回退以及常见运维模式。 - [API7 网关 AI Agent Skill：basic-auth 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-basic-auth.md): 用于通过 a7 CLI 配置 API7 企业版 basic-auth 插件的 Skill，涵盖路由上的 HTTP Basic Authentication、带用户名和密码的消费者凭证关联、hide_credentials、匿名消费者回退以及常见运维模式。 #### a7-plugin-consumer-restriction 用于通过 a7 CLI 配置 API7 企业版 consumer-restriction 插件的 Skill，涵盖按消费者名称、服务 ID 或路由 ID 进行访问限制，白名单/黑名单模式以及按消费者限制 HTTP 方法。 - [API7 网关 AI Agent Skill：consumer-restriction 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-consumer-restriction.md): 用于通过 a7 CLI 配置 API7 企业版 consumer-restriction 插件的 Skill，涵盖按消费者名称、服务 ID 或路由 ID 进行访问限制，白名单/黑名单模式以及按消费者限制 HTTP 方法。 #### a7-plugin-cors 用于通过 a7 CLI 配置 API7 企业版 cors 插件的 Skill，涵盖路由上的跨源资源共享（CORS）、allow_origins、allow_methods、allow_headers、凭证处理、正则来源匹配、预检缓存以及常见运维模式。 - [API7 网关 AI Agent Skill：cors 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-cors.md): 用于通过 a7 CLI 配置 API7 企业版 cors 插件的 Skill，涵盖路由上的跨源资源共享（CORS）、allow_origins、allow_methods、allow_headers、凭证处理、正则来源匹配、预检缓存以及常见运维模式。 #### a7-plugin-datadog 用于通过 a7 CLI 配置 API7 企业版 datadog 插件的 Skill，涵盖通过 DogStatsD 向 Datadog 推送自定义指标、指标标签、批处理、全局 DogStatsD 服务器配置的插件元数据以及 Datadog Agent 集成。 - [API7 网关 AI Agent Skill：datadog 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-datadog.md): 用于通过 a7 CLI 配置 API7 企业版 datadog 插件的 Skill，涵盖通过 DogStatsD 向 Datadog 推送自定义指标、指标标签、批处理、全局 DogStatsD 服务器配置的插件元数据以及 Datadog Agent 集成。 #### a7-plugin-ext-plugin 用于通过 a7 CLI 配置 API7 企业版外部插件系统（ext-plugin-pre-req、ext-plugin-post-req、ext-plugin-post-resp）的 Skill，涵盖 Plugin Runner 架构、Go/Java/Python Runner 配置、RPC 协议、优雅降级以及性能注意事项。 - [API7 网关 AI Agent Skill：ext-plugin 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-ext-plugin.md): 用于通过 a7 CLI 配置 API7 企业版外部插件系统（ext-plugin-pre-req、ext-plugin-post-req、ext-plugin-post-resp）的 Skill，涵盖 Plugin Runner 架构、Go/Java/Python Runner 配置、RPC 协议、优雅降级以及性能注意事项。 #### a7-plugin-fault-injection 用于通过 a7 CLI 配置 API7 企业版 fault-injection 插件的 Skill，涵盖为混沌工程注入延迟和 HTTP 中断、基于百分比的采样、通过 vars 表达式进行条件注入，以及自定义响应头和带 NGINX 变量插值的响应体。 - [API7 网关 AI Agent Skill：fault-injection 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-fault-injection.md): 用于通过 a7 CLI 配置 API7 企业版 fault-injection 插件的 Skill，涵盖为混沌工程注入延迟和 HTTP 中断、基于百分比的采样、通过 vars 表达式进行条件注入，以及自定义响应头和带 NGINX 变量插值的响应体。 #### a7-plugin-grpc-transcode 用于通过 a7 CLI 配置 API7 企业版 grpc-transcode 插件的 Skill，涵盖将 RESTful HTTP 请求转换为 gRPC、proto 文件管理、用于数据类型转换的 pb_option 设置、错误详情解码以及网关组作用域。 - [API7 网关 AI Agent Skill：grpc-transcode 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-grpc-transcode.md): 用于通过 a7 CLI 配置 API7 企业版 grpc-transcode 插件的 Skill，涵盖将 RESTful HTTP 请求转换为 gRPC、proto 文件管理、用于数据类型转换的 pb_option 设置、错误详情解码以及网关组作用域。 #### a7-plugin-hmac-auth 用于通过 a7 CLI 配置 API7 企业版 hmac-auth 插件的 Skill，涵盖 HMAC 签名身份认证、带 key_id/secret_key 的消费者凭证关联、允许的算法、时钟偏差处理、请求体校验、签名请求头以及常见运维模式。 - [API7 网关 AI Agent Skill：hmac-auth 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-hmac-auth.md): 用于通过 a7 CLI 配置 API7 企业版 hmac-auth 插件的 Skill，涵盖 HMAC 签名身份认证、带 key_id/secret_key 的消费者凭证关联、允许的算法、时钟偏差处理、请求体校验、签名请求头以及常见运维模式。 #### a7-plugin-http-logger 用于通过 a7 CLI 配置 API7 企业版 http-logger 插件的 Skill，涵盖批量向 HTTP/HTTPS 端点推送访问日志、自定义日志格式以及网关组作用域。 - [API7 网关 AI Agent Skill：http-logger 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-http-logger.md): 用于通过 a7 CLI 配置 API7 企业版 http-logger 插件的 Skill，涵盖批量向 HTTP/HTTPS 端点推送访问日志、自定义日志格式以及网关组作用域。 #### a7-plugin-ip-restriction 用于通过 a7 CLI 配置 API7 企业版 ip-restriction 插件的 Skill，涵盖路由上的 IP 白名单/黑名单、CIDR 范围、IPv4/IPv6、代理后提取真实客户端 IP、自定义错误消息以及常见运维模式。 - [API7 网关 AI Agent Skill：ip-restriction 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-ip-restriction.md): 用于通过 a7 CLI 配置 API7 企业版 ip-restriction 插件的 Skill，涵盖路由上的 IP 白名单/黑名单、CIDR 范围、IPv4/IPv6、代理后提取真实客户端 IP、自定义错误消息以及常见运维模式。 #### a7-plugin-jwt-auth 用于通过 a7 CLI 配置 API7 企业版 jwt-auth 插件的 Skill，涵盖 JSON Web Token（JWT）身份认证、HS256/RS256 算法选择、消费者凭证关联、从请求头、查询参数或 Cookie 查找令牌、声明处理、时钟偏差、密钥管理以及常见运维模式。 - [API7 网关 AI Agent Skill：jwt-auth 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-jwt-auth.md): 用于通过 a7 CLI 配置 API7 企业版 jwt-auth 插件的 Skill，涵盖 JSON Web Token（JWT）身份认证、HS256/RS256 算法选择、消费者凭证关联、从请求头、查询参数或 Cookie 查找令牌、声明处理、时钟偏差、密钥管理以及常见运维模式。 #### a7-plugin-kafka-logger 用于通过 a7 CLI 配置 API7 企业版 kafka-logger 插件的 Skill，涵盖向 Apache Kafka 主题推送访问日志、Broker 配置、SASL 身份认证以及网关组作用域。 - [API7 网关 AI Agent Skill：kafka-logger 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-kafka-logger.md): 用于通过 a7 CLI 配置 API7 企业版 kafka-logger 插件的 Skill，涵盖向 Apache Kafka 主题推送访问日志、Broker 配置、SASL 身份认证以及网关组作用域。 #### a7-plugin-key-auth 用于通过 a7 CLI 配置 API7 企业版 key-auth 插件的 Skill，涵盖路由上的 API Key（API 密钥）身份认证、消费者凭证关联、从请求头、查询参数或 Cookie 查找 API Key、hide_credentials、匿名消费者回退以及常见运维模式。 - [API7 网关 AI Agent Skill：key-auth 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-key-auth.md): 用于通过 a7 CLI 配置 API7 企业版 key-auth 插件的 Skill，涵盖路由上的 API Key（API 密钥）身份认证、消费者凭证关联、从请求头、查询参数或 Cookie 查找 API Key、hide_credentials、匿名消费者回退以及常见运维模式。 #### a7-plugin-limit-count 用于通过 a7 CLI 配置 API7 企业版 limit-count 插件的 Skill，涵盖固定窗口限流、count/time_window 配置、Key 类型、用于分布式限流的 Redis 和 Redis 集群策略、基于组的共享配额、消费者级与路由级限流、响应头以及常见运维模式。 - [API7 网关 AI Agent Skill：limit-count 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-limit-count.md): 用于通过 a7 CLI 配置 API7 企业版 limit-count 插件的 Skill，涵盖固定窗口限流、count/time_window 配置、Key 类型、用于分布式限流的 Redis 和 Redis 集群策略、基于组的共享配额、消费者级与路由级限流、响应头以及常见运维模式。 #### a7-plugin-limit-req 用于通过 a7 CLI 配置 API7 企业版 limit-req 插件的 Skill，涵盖漏桶限流、rate/burst 配置、nodelay 行为、Key 类型、用于分布式限流的 Redis 策略、流量平滑以及与 limit-count 组合使用等常见运维模式。 - [API7 网关 AI Agent Skill：limit-req 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-limit-req.md): 用于通过 a7 CLI 配置 API7 企业版 limit-req 插件的 Skill，涵盖漏桶限流、rate/burst 配置、nodelay 行为、Key 类型、用于分布式限流的 Redis 策略、流量平滑以及与 limit-count 组合使用等常见运维模式。 #### a7-plugin-openid-connect 用于通过 a7 CLI 配置 API7 企业版 openid-connect 插件的 Skill，涵盖 OpenID Connect（OIDC）授权码流程、Bearer 令牌校验、令牌内省与 JWKS 校验、会话管理、Keycloak、Auth0、Okta 等身份提供方配置、重定向 URI 以及常见运维模式。 - [API7 网关 AI Agent Skill：openid-connect 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-openid-connect.md): 用于通过 a7 CLI 配置 API7 企业版 openid-connect 插件的 Skill，涵盖 OpenID Connect（OIDC）授权码流程、Bearer 令牌校验、令牌内省与 JWKS 校验、会话管理、Keycloak、Auth0、Okta 等身份提供方配置、重定向 URI 以及常见运维模式。 #### a7-plugin-prometheus 用于通过 a7 CLI 配置 API7 企业版 prometheus 插件的 Skill，涵盖在路由级和全局启用 Prometheus 指标导出、公开的指标（HTTP 状态、延迟、带宽、上游健康状况）以及网关组作用域。 - [API7 网关 AI Agent Skill：prometheus 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-prometheus.md): 用于通过 a7 CLI 配置 API7 企业版 prometheus 插件的 Skill，涵盖在路由级和全局启用 Prometheus 指标导出、公开的指标（HTTP 状态、延迟、带宽、上游健康状况）以及网关组作用域。 #### a7-plugin-proxy-rewrite 用于通过 a7 CLI 配置 API7 企业版 proxy-rewrite 插件的 Skill，涵盖将请求 URI、主机、方法、请求头和协议重写后再转发到上游，包括正则 URI 重写、请求头操作以及网关组作用域。 - [API7 网关 AI Agent Skill：proxy-rewrite 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-proxy-rewrite.md): 用于通过 a7 CLI 配置 API7 企业版 proxy-rewrite 插件的 Skill，涵盖将请求 URI、主机、方法、请求头和协议重写后再转发到上游，包括正则 URI 重写、请求头操作以及网关组作用域。 #### a7-plugin-redirect 用于通过 a7 CLI 配置 API7 企业版 redirect 插件的 Skill，涵盖 URI 重定向、HTTP 到 HTTPS 重定向、基于正则的 URI 重写、查询字符串处理以及网关组作用域。 - [API7 网关 AI Agent Skill：redirect 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-redirect.md): 用于通过 a7 CLI 配置 API7 企业版 redirect 插件的 Skill，涵盖 URI 重定向、HTTP 到 HTTPS 重定向、基于正则的 URI 重写、查询字符串处理以及网关组作用域。 #### a7-plugin-response-rewrite 用于通过 a7 CLI 配置 API7 企业版 response-rewrite 插件的 Skill，涵盖向客户端返回前重写响应状态码、响应头和响应体，包括使用 vars 条件执行、正则响应体过滤器以及网关组作用域。 - [API7 网关 AI Agent Skill：response-rewrite 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-response-rewrite.md): 用于通过 a7 CLI 配置 API7 企业版 response-rewrite 插件的 Skill，涵盖向客户端返回前重写响应状态码、响应头和响应体，包括使用 vars 条件执行、正则响应体过滤器以及网关组作用域。 #### a7-plugin-serverless 用于通过 a7 CLI 配置 API7 企业版 serverless-pre-function 和 serverless-post-function 插件的 Skill，涵盖在可配置请求阶段执行内联 Lua 函数、函数签名、闭包模式、可用 Lua API 以及执行顺序。 - [API7 网关 AI Agent Skill：serverless 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-serverless.md): 用于通过 a7 CLI 配置 API7 企业版 serverless-pre-function 和 serverless-post-function 插件的 Skill，涵盖在可配置请求阶段执行内联 Lua 函数、函数签名、闭包模式、可用 Lua API 以及执行顺序。 #### a7-plugin-skywalking 用于通过 a7 CLI 配置 API7 企业版 skywalking 插件的 Skill，涵盖使用 Apache SkyWalking OAP 进行分布式追踪、采样配置、服务拓扑以及网关组作用域。 - [API7 网关 AI Agent Skill：skywalking 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-skywalking.md): 用于通过 a7 CLI 配置 API7 企业版 skywalking 插件的 Skill，涵盖使用 Apache SkyWalking OAP 进行分布式追踪、采样配置、服务拓扑以及网关组作用域。 #### a7-plugin-traffic-split 用于通过 a7 CLI 配置 API7 企业版 traffic-split 插件的 Skill，涵盖通过条件匹配规则在上游之间进行加权流量拆分，包括灰度发布、蓝绿发布、A/B 测试模式以及网关组作用域。 - [API7 网关 AI Agent Skill：traffic-split 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-traffic-split.md): 用于通过 a7 CLI 配置 API7 企业版 traffic-split 插件的 Skill，涵盖通过条件匹配规则在上游之间进行加权流量拆分，包括灰度发布、蓝绿发布、A/B 测试模式以及网关组作用域。 #### a7-plugin-wolf-rbac 用于通过 a7 CLI 配置 API7 企业版 wolf-rbac 插件的 Skill，涵盖与 Wolf RBAC 服务器集成以实现基于角色的访问控制、令牌管理、登录、用户信息、修改密码 API 端点、权限检查流程以及多应用配置。 - [API7 网关 AI Agent Skill：wolf-rbac 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-wolf-rbac.md): 用于通过 a7 CLI 配置 API7 企业版 wolf-rbac 插件的 Skill，涵盖与 Wolf RBAC 服务器集成以实现基于角色的访问控制、令牌管理、登录、用户信息、修改密码 API 端点、权限检查流程以及多应用配置。 #### a7-plugin-zipkin 用于通过 a7 CLI 配置 API7 企业版 zipkin 插件的 Skill，涵盖使用 Zipkin、Jaeger 或任何兼容 Zipkin 的采集器进行分布式追踪、B3 传播请求头、采样以及网关组作用域。 - [API7 网关 AI Agent Skill：zipkin 插件](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-plugin-zipkin.md): 用于通过 a7 CLI 配置 API7 企业版 zipkin 插件的 Skill，涵盖使用 Zipkin、Jaeger 或任何兼容 Zipkin 的采集器进行分布式追踪、B3 传播请求头、采样以及网关组作用域。 #### a7-recipe-api-versioning 使用 API7 企业版和 a7 CLI 实现 API 版本管理策略的方案 Skill，涵盖 URI 路径版本管理、基于请求头的版本管理、用于渐进式迁移的流量拆分以及版本生命周期管理。 - [API7 网关 AI Agent Skill：API 版本管理方案](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-recipe-api-versioning.md): 使用 API7 企业版和 a7 CLI 实现 API 版本管理策略的方案 Skill，涵盖 URI 路径版本管理、基于请求头的版本管理、用于渐进式迁移的流量拆分以及版本生命周期管理。 #### a7-recipe-blue-green 使用 a7 CLI 在 API7 企业版中实现蓝绿发布的方案 Skill，涵盖创建两个基于服务的环境、通过更新路由 service_id 切换流量、回滚流程以及限定网关组的配置同步工作流。 - [API7 网关 AI Agent Skill：蓝绿发布方案](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-recipe-blue-green.md): 使用 a7 CLI 在 API7 企业版中实现蓝绿发布的方案 Skill，涵盖创建两个基于服务的环境、通过更新路由 service_id 切换流量、回滚流程以及限定网关组的配置同步工作流。 #### a7-recipe-canary 使用 a7 CLI 在 API7 企业版中实现灰度发布的方案 Skill，涵盖通过 traffic-split 插件渐进式转移流量、基于请求头的灰度路由、监控检查点以及完整的发布或回滚工作流。 - [API7 网关 AI Agent Skill：灰度发布方案](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-recipe-canary.md): 使用 a7 CLI 在 API7 企业版中实现灰度发布的方案 Skill，涵盖通过 traffic-split 插件渐进式转移流量、基于请求头的灰度路由、监控检查点以及完整的发布或回滚工作流。 #### a7-recipe-circuit-breaker 使用 a7 CLI 在 API7 企业版中实现服务熔断模式的方案 Skill，涵盖 api-breaker 插件、不健康阈值、健康恢复、响应码分类以及与服务健康检查的集成。 - [API7 网关 AI Agent Skill：熔断方案](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-recipe-circuit-breaker.md): 使用 a7 CLI 在 API7 企业版中实现服务熔断模式的方案 Skill，涵盖 api-breaker 插件、不健康阈值、健康恢复、响应码分类以及与服务健康检查的集成。 #### a7-recipe-graphql-proxy 使用 API7 企业版和 a7 CLI 实现 GraphQL 代理模式的方案 Skill，涵盖基于操作的路由、按操作限流、REST 到 GraphQL 转换以及 GraphQL API 的企业级安全。 - [API7 网关 AI Agent Skill：GraphQL 代理方案](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-recipe-graphql-proxy.md): 使用 API7 企业版和 a7 CLI 实现 GraphQL 代理模式的方案 Skill，涵盖基于操作的路由、按操作限流、REST 到 GraphQL 转换以及 GraphQL API 的企业级安全。 #### a7-recipe-health-check 使用 a7 CLI 在 API7 企业版中配置后端健康检查的方案 Skill，涵盖主动健康检查、被动健康检查、两者组合、健康/不健康阈值以及基于服务的路由关联。 - [API7 网关 AI Agent Skill：健康检查方案](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-recipe-health-check.md): 使用 a7 CLI 在 API7 企业版中配置后端健康检查的方案 Skill，涵盖主动健康检查、被动健康检查、两者组合、健康/不健康阈值以及基于服务的路由关联。 #### a7-recipe-mtls 使用 a7 CLI 在 API7 企业版中配置双向 TLS（mTLS）的方案 Skill，涵盖 SSL 证书管理、到后端服务的上游 mTLS、客户端证书校验以及从客户端经 API7 企业版到上游的端到端 mTLS 配置。 - [API7 网关 AI Agent Skill：mTLS 方案](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-recipe-mtls.md): 使用 a7 CLI 在 API7 企业版中配置双向 TLS（mTLS）的方案 Skill，涵盖 SSL 证书管理、到后端服务的上游 mTLS、客户端证书校验以及从客户端经 API7 企业版到上游的端到端 mTLS 配置。 #### a7-recipe-multi-tenant 使用 API7 企业版和 a7 CLI 实现多租户模式的方案 Skill，涵盖网关组隔离、消费者策略、基于服务的租户路由以及基于凭证的租户访问。 - [API7 网关 AI Agent Skill：多租户方案](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-recipe-multi-tenant.md): 使用 API7 企业版和 a7 CLI 实现多租户模式的方案 Skill，涵盖网关组隔离、消费者策略、基于服务的租户路由以及基于凭证的租户访问。 #### a7-shared 使用 API7 企业版命令行工具 a7 的核心 Skill，提供项目约定、命令模式、双 API 架构和开发工作流；在处理 a7 源代码、添加新命令、编写测试或修改任何 a7 组件时加载此 Skill。 - [API7 网关 AI Agent Skill：共享 CLI 约定](https://docs.apiseven.com/api7-gateway/ai-agent-skills/a7-shared.md): 使用 API7 企业版命令行工具 a7 的核心 Skill，提供项目约定、命令模式、双 API 架构和开发工作流；在处理 a7 源代码、添加新命令、编写测试或修改任何 a7 组件时加载此 Skill。 ### ai-gateway #### get-started 在 5 分钟内配置 API7 AI 网关并代理第一个 OpenAI 请求，包含分步说明和代码示例。 - [5 分钟代理第一个大语言模型请求](https://docs.apiseven.com/api7-gateway/ai-gateway/get-started.md): 在 5 分钟内配置 API7 AI 网关并代理第一个 OpenAI 请求，包含分步说明和代码示例。 #### llm-providers - [接入 Anthropic Claude](https://docs.apiseven.com/api7-gateway/ai-gateway/llm-providers/anthropic.md): 通过 API7 网关路由 Anthropic Claude API 流量，集中实施安全、限流和可观测性策略。 - [集成 Azure OpenAI Service](https://docs.apiseven.com/api7-gateway/ai-gateway/llm-providers/azure-openai.md): 通过 API7 网关管理 Azure OpenAI Deployment，集中处理资源名称、API 版本和身份认证。 - [将流量路由到 DeepSeek 模型](https://docs.apiseven.com/api7-gateway/ai-gateway/llm-providers/deepseek.md): 通过 API7 网关代理 DeepSeek API 请求，集中管理身份认证、启用故障转移并监控用量。 - [接入 Google Gemini](https://docs.apiseven.com/api7-gateway/ai-gateway/llm-providers/google-gemini.md): 通过 API7 网关代理 Google Gemini API 请求，集中管理 API Key（API 密钥）并监控 AI 流量。 - [将流量路由到 OpenAI](https://docs.apiseven.com/api7-gateway/ai-gateway/llm-providers/openai.md): 通过 API7 网关代理和保护 OpenAI API 请求，集中管理身份认证、启用故障转移并监控用量。 - [接入任意 OpenAI 兼容大语言模型](https://docs.apiseven.com/api7-gateway/ai-gateway/llm-providers/openai-compatible.md): 通过 API7 网关代理任意 OpenAI 兼容 API，接入自托管模型、自定义端点或小众服务提供方。 - [通过 OpenRouter 接入数百种大语言模型](https://docs.apiseven.com/api7-gateway/ai-gateway/llm-providers/openrouter.md): 通过 API7 AI 网关接入 OpenRouter，使用一个 API 访问 200 多种大语言模型，同时保持企业级安全控制。 - [将企业 AI 流量路由到 Vertex AI](https://docs.apiseven.com/api7-gateway/ai-gateway/llm-providers/vertex-ai.md): 通过 API7 网关安全代理 Google Cloud Vertex AI 请求，支持服务账户身份认证和区域路由。 #### overview 使用 API7 AI 网关集中管理大语言模型访问，通过一个平台将流量路由到多个服务提供方、实施安全护栏并控制成本。 - [管理和保护 AI 流量](https://docs.apiseven.com/api7-gateway/ai-gateway/overview.md): 使用 API7 AI 网关集中管理大语言模型访问，通过一个平台将流量路由到多个服务提供方、实施安全护栏并控制成本。 #### use-cases - [监控 AI 流量并跟踪大语言模型成本](https://docs.apiseven.com/api7-gateway/ai-gateway/use-cases/ai-observability-and-cost-tracking.md): 使用 API7 AI 网关的可观测性功能，洞察大语言模型用量、Token 消耗、延迟和成本。 - [使用 AI 重写转换 API 请求](https://docs.apiseven.com/api7-gateway/ai-gateway/use-cases/ai-request-transformation.md): 在网关层使用大语言模型智能地转换、丰富或重构 API 请求与响应。 - [实施 AI 安全护栏并保护 PII](https://docs.apiseven.com/api7-gateway/ai-gateway/use-cases/content-safety-and-guardrails.md): 使用 API7 AI 网关安全护栏，在请求到达大语言模型前阻止提示词注入、检测有害内容并脱敏 PII。 - [将 REST API 暴露为 AI Agent 的 MCP 工具](https://docs.apiseven.com/api7-gateway/ai-gateway/use-cases/expose-apis-as-mcp-tools.md): 将现有 OpenAPI 服务转换为 MCP 兼容工具，使 AI Agent（AI 智能体）能够自动发现并调用 API。 - [通过 API7-MCP 在 AI 客户端中管理 API7 企业版](https://docs.apiseven.com/api7-gateway/ai-gateway/use-cases/manage-api7-with-mcp.md): 部署 API7-MCP，让 Cursor、Claude Desktop、Cline 等 AI 客户端读取 API7 企业版资源、查看 Prometheus 指标、管理基于角色的访问控制（RBAC），并通过网关发送测试流量。 - [配置多模型路由和自动故障转移](https://docs.apiseven.com/api7-gateway/ai-gateway/use-cases/multi-llm-routing-and-fallback.md): 使用加权负载均衡、自动故障转移和健康检查，在多个模型服务提供方之间路由 AI 流量。 - [实现提示词模板和装饰器](https://docs.apiseven.com/api7-gateway/ai-gateway/use-cases/prompt-engineering-and-templating.md): 使用 API7 AI 网关的可复用提示词模板和自动系统提示词注入，规范大语言模型交互。 - [将 Anthropic Messages 转换为 OpenAI Chat Completions](https://docs.apiseven.com/api7-gateway/ai-gateway/use-cases/protocol-conversion.md): 使用 API7 AI 网关透明地将 Anthropic Messages API 请求转换为 OpenAI Chat Completions API 格式，使团队能够通过 Anthropic SDK 使用任意 OpenAI 兼容后端。 - [在网关层实现 RAG](https://docs.apiseven.com/api7-gateway/ai-gateway/use-cases/retrieval-augmented-generation.md): 使用 API7 AI 网关内置的检索增强生成（RAG），通过相关上下文提升大语言模型响应质量。 - [使用基于 Token 的限流控制 AI 成本](https://docs.apiseven.com/api7-gateway/ai-gateway/use-cases/token-rate-limiting-and-quota-management.md): 实施基于 Token 的限流，防止大语言模型被滥用，并按路由和模型实例控制 AI 成本。 ### api-observability #### alert 按照本指南在 API7 企业版中创建告警策略，以便接收特定事件的通知并监控系统性能。 - [触发网关告警](https://docs.apiseven.com/api7-gateway/api-observability/alert.md): 按照本指南在 API7 企业版中创建告警策略，以便接收特定事件的通知并监控系统性能。 #### log-consumer-label-in-access-log 按照本指南在 API7 企业版的访问日志中记录消费者标签，以增强 API 的管理和安全性。 - [在访问日志中记录消费者标签](https://docs.apiseven.com/api7-gateway/api-observability/log-consumer-label-in-access-log.md): 按照本指南在 API7 企业版的访问日志中记录消费者标签，以增强 API 的管理和安全性。 #### logging 按照本指南在 API7 企业版中配置 API 流量日志记录，与各种日志平台集成以捕获详细的访问日志。 - [记录 API 流量日志](https://docs.apiseven.com/api7-gateway/api-observability/logging.md): 按照本指南在 API7 企业版中配置 API 流量日志记录，与各种日志平台集成以捕获详细的访问日志。 #### monitoring 按照本指南在 API7 企业版中监控 API 指标，利用 Prometheus 插件来有效追踪和可视化 HTTP 指标。 - [监控 API 指标](https://docs.apiseven.com/api7-gateway/api-observability/monitoring.md): 按照本指南在 API7 企业版中监控 API 指标，利用 Prometheus 插件来有效追踪和可视化 HTTP 指标。 #### tracing 按照本指南在 API7 企业版中使用 opentelemetry 插件设置追踪，实现对请求在系统中的旅程的监控。 - [追踪 API 流量](https://docs.apiseven.com/api7-gateway/api-observability/tracing.md): 按照本指南在 API7 企业版中使用 opentelemetry 插件设置追踪，实现对请求在系统中的旅程的监控。 ### best-practices #### blue-green-deployment 按照本指南在 API7 企业版中设置蓝绿发布，通过使用两个相同的环境，将应用程序更新期间的停机时间和风险降至最低。 - [配置蓝绿发布](https://docs.apiseven.com/api7-gateway/best-practices/blue-green-deployment.md): 按照本指南在 API7 企业版中设置蓝绿发布，通过使用两个相同的环境，将应用程序更新期间的停机时间和风险降至最低。 #### configure-grpc 按照本指南配置 API7 网关以代理 gRPC 流量，使你能够使用 HTTP/2 处理高性能的远程过程调用（RPC）。 - [代理 gRPC 流量](https://docs.apiseven.com/api7-gateway/best-practices/configure-grpc.md): 按照本指南配置 API7 网关以代理 gRPC 流量，使你能够使用 HTTP/2 处理高性能的远程过程调用（RPC）。 #### custom-plugin 遵循本指南在 API7 企业版中添加自定义插件，通过使用 Lua 编程定制逻辑来扩展功能和管理 API 流量。 - [添加自定义插件](https://docs.apiseven.com/api7-gateway/best-practices/custom-plugin.md): 遵循本指南在 API7 企业版中添加自定义插件，通过使用 Lua 编程定制逻辑来扩展功能和管理 API 流量。 #### dashboard-sso - [使用 LDAP 配置控制台 SSO](https://docs.apiseven.com/api7-gateway/best-practices/dashboard-sso/ldap.md): 按照本指南在 API7 企业版中使用 LDAP 协议配置单点登录 (SSO)，简化用户身份验证并增强安全性。 - [使用 Auth0 配置控制台 SSO](https://docs.apiseven.com/api7-gateway/best-practices/dashboard-sso/oidc/auth0.md): 按照本指南在 API7 企业版中使用 OIDC 协议配置基于 Auth0 的单点登录 (SSO)，简化用户身份验证并增强安全性。 - [使用 Microsoft Entra ID 配置控制台 SSO](https://docs.apiseven.com/api7-gateway/best-practices/dashboard-sso/oidc/azure-ad.md): 按照本指南在 API7 企业版中使用 OIDC 协议配置基于 Microsoft Entra ID (Azure AD) 的单点登录 (SSO)，简化用户身份验证并增强安全性。 - [使用 Keycloak 配置控制台单点登录（SSO）](https://docs.apiseven.com/api7-gateway/best-practices/dashboard-sso/oidc/keycloak.md): 按照本指南在 API7 企业版中使用 OIDC 和 Keycloak 配置单点登录（SSO），从而简化用户身份认证并增强安全性。 - [使用 Microsoft Entra ID 和 SAML 配置控制台 SSO](https://docs.apiseven.com/api7-gateway/best-practices/dashboard-sso/saml/azure-ad.md): 按照本指南在 API7 企业版中使用 SAML 协议配置基于 Microsoft Entra ID (Azure AD) 的单点登录 (SSO)，简化用户身份验证并增强安全性。 - [使用 Okta 和 SAML 配置控制台 SSO](https://docs.apiseven.com/api7-gateway/best-practices/dashboard-sso/saml/okta.md): 按照本指南在 API7 企业版中使用 SAML 协议配置基于 Okta 的单点登录 (SSO)，简化用户身份验证并在控制台中启用角色映射。 #### data-masking-access-log 了解如何在 API 网关访问日志中有效脱敏诸如电子邮件地址之类的敏感数据，以增强安全性并确保可靠的 API 管理。 - [在访问日志中脱敏敏感数据](https://docs.apiseven.com/api7-gateway/best-practices/data-masking-access-log.md): 了解如何在 API 网关访问日志中有效脱敏诸如电子邮件地址之类的敏感数据，以增强安全性并确保可靠的 API 管理。 #### design-custom-role-system 按照本指南在 API7 企业版中设计并实现自定义角色系统，授予用户细粒度的访问权限以增强安全性和数据完整性。 - [设计自定义角色系统](https://docs.apiseven.com/api7-gateway/best-practices/design-custom-role-system.md): 按照本指南在 API7 企业版中设计并实现自定义角色系统，授予用户细粒度的访问权限以增强安全性和数据完整性。 #### devops-adc 按照本指南使用 API7 声明式 CLI（ADC）声明式地管理 API7 企业版配置，轻松与版本控制系统和 CI/CD 流水线集成。 - [声明式管理 API7 企业版](https://docs.apiseven.com/api7-gateway/best-practices/devops-adc.md): 按照本指南使用 API7 声明式 CLI（ADC）声明式地管理 API7 企业版配置，轻松与版本控制系统和 CI/CD 流水线集成。 #### disable-global-plugins-conditionally 了解如何在 API7 企业版中有条件地禁用全局插件执行，使你可以根据特定要求灵活控制插件的执行。 - [有条件地禁用全局插件](https://docs.apiseven.com/api7-gateway/best-practices/disable-global-plugins-conditionally.md): 了解如何在 API7 企业版中有条件地禁用全局插件执行，使你可以根据特定要求灵活控制插件的执行。 #### forward-auth-user-info-to-upstream 在使用 OpenID Connect 或 SAML Auth 等认证插件时，你可能需要将经过身份验证的用户信息传递给上游服务。这使上游应用程序能够基于用户身份实现额外的业务逻辑，例如个性化、审计和访问控制。 - [将外部认证的用户信息转发到上游](https://docs.apiseven.com/api7-gateway/best-practices/forward-auth-user-info-to-upstream.md): 在使用 OpenID Connect 或 SAML Auth 等认证插件时，你可能需要将经过身份验证的用户信息传递给上游服务。这使上游应用程序能够基于用户身份实现额外的业务逻辑，例如个性化、审计和访问控制。 #### gateway-error-log-kubernetes-splunk 了解如何将部署在 Kubernetes 环境中的多个网关的错误日志转发至 Splunk，以进行集中式的日志管理。 - [将 Kubernetes 的错误日志转发至 Splunk](https://docs.apiseven.com/api7-gateway/best-practices/gateway-error-log-kubernetes-splunk.md): 了解如何将部署在 Kubernetes 环境中的多个网关的错误日志转发至 Splunk，以进行集中式的日志管理。 #### gateway-health-probe 按照本指南在 API7 企业版中启用健康检查探针，通过监控上游节点的健康状况来确保网关的稳定性和可靠性。 - [执行网关健康检查探针](https://docs.apiseven.com/api7-gateway/best-practices/gateway-health-probe.md): 按照本指南在 API7 企业版中启用健康检查探针，通过监控上游节点的健康状况来确保网关的稳定性和可靠性。 #### manage-token 按照本指南在 API7 企业版中实施基于 Token 的身份验证，实现与 GitOps 工作流的无缝集成并增强安全性。 - [使用 Token 集成 GitOps 工作流](https://docs.apiseven.com/api7-gateway/best-practices/manage-token.md): 按照本指南在 API7 企业版中实施基于 Token 的身份验证，实现与 GitOps 工作流的无缝集成并增强安全性。 #### plugin-development-best-practices 通过使用 apisix.core 库而非底层 OpenResty API、用 schema 校验配置、选择正确的阶段与优先级，编写正确、高性能且易维护的自定义 Lua 插件。 - [插件开发最佳实践](https://docs.apiseven.com/api7-gateway/best-practices/plugin-development-best-practices.md): 通过使用 apisix.core 库而非底层 OpenResty API、用 schema 校验配置、选择正确的阶段与优先级，编写正确、高性能且易维护的自定义 Lua 插件。 #### proxy-tcp-traffic 按照本指南配置 API7 网关以处理 TCP 和 UDP 流量，从而为 MySQL 等各种后端服务启用传输层 (四层) 代理。 - [代理 TCP 流量](https://docs.apiseven.com/api7-gateway/best-practices/proxy-tcp-traffic.md): 按照本指南配置 API7 网关以处理 TCP 和 UDP 流量，从而为 MySQL 等各种后端服务启用传输层 (四层) 代理。 #### route-priority-matching-conditions 遵循本指南使用 Ingress Controller 配置路由优先级和高级匹配条件，以实现更细粒度的 API 管理。 - [设置路由优先级和匹配条件 (Ingress Controller)](https://docs.apiseven.com/api7-gateway/best-practices/route-priority-matching-conditions.md): 遵循本指南使用 Ingress Controller 配置路由优先级和高级匹配条件，以实现更细粒度的 API 管理。 #### scim - [使用 Okta 配置 SCIM 账号同步](https://docs.apiseven.com/api7-gateway/best-practices/scim/okta.md): 按照本指南在 API7 企业版中配置基于 Okta 的 SCIM 账号同步，实现身份提供商和 API7 控制台之间的用户自动同步。 #### serverless-or-custom-plugins 对比内置的 serverless 函数插件与自定义 Lua 插件，为在 API7 网关中运行自己的 Lua 逻辑选择合适的方式。 - [Serverless 函数还是自定义插件](https://docs.apiseven.com/api7-gateway/best-practices/serverless-or-custom-plugins.md): 对比内置的 serverless 函数插件与自定义 Lua 插件，为在 API7 网关中运行自己的 Lua 逻辑选择合适的方式。 #### service-discovery 按照本指南在 API7 企业版中配置服务发现机制，以支持动态探测上游节点并增强 API 管理的灵活性。 - [使用服务发现配置上游](https://docs.apiseven.com/api7-gateway/best-practices/service-discovery.md): 按照本指南在 API7 企业版中配置服务发现机制，以支持动态探测上游节点并增强 API 管理的灵活性。 #### telemetry-compression 按照本指南配置从 API7 企业版数据面（DP）到控制面（CP）的遥测数据压缩，以提高网络性能并降低 CPU 使用率。 - [优化遥测数据传输](https://docs.apiseven.com/api7-gateway/best-practices/telemetry-compression.md): 按照本指南配置从 API7 企业版数据面（DP）到控制面（CP）的遥测数据压缩，以提高网络性能并降低 CPU 使用率。 #### upstream-ha 按照本指南在 API7 企业版中通过添加多个上游节点、修改负载均衡类型以及启用健康检查来确保上游的高可用性。 - [确保上游高可用性](https://docs.apiseven.com/api7-gateway/best-practices/upstream-ha.md): 按照本指南在 API7 企业版中通过添加多个上游节点、修改负载均衡类型以及启用健康检查来确保上游的高可用性。 #### verify-api7-image-signatures 遵循本指南使用 Cosign 验证 API7 Docker 镜像签名，确保软件供应链中镜像的真实性和完整性。 - [验证 API7 镜像签名](https://docs.apiseven.com/api7-gateway/best-practices/verify-api7-image-signatures.md): 遵循本指南使用 Cosign 验证 API7 Docker 镜像签名，确保软件供应链中镜像的真实性和完整性。 ### configure-and-manage #### benchmark-on-aws-eks 在 AWS EKS 上重现已发布的 API7 网关性能基准。演练涵盖 EKS 集群设置、三个独立节点组、Helm 安装、NGINX 上游和 wrk2 部署以及运行完整的场景套件。 - [在 AWS EKS 上运行基准](https://docs.apiseven.com/api7-gateway/configure-and-manage/benchmark-on-aws-eks.md): 在 AWS EKS 上重现已发布的 API7 网关性能基准。演练涵盖 EKS 集群设置、三个独立节点组、Helm 安装、NGINX 上游和 wrk2 部署以及运行完整的场景套件。 #### configure-control-plane API7 网关控制面的详细配置参考，涵盖控制台和 DP Manager 配置文件。 - [API7 网关控制面配置参考](https://docs.apiseven.com/api7-gateway/configure-and-manage/configure-control-plane.md): API7 网关控制面的详细配置参考，涵盖控制台和 DP Manager 配置文件。 #### configure-data-plane API7 网关数据面的详细配置参考，基于 config-default.yaml 结构。 - [API7 网关数据面配置参考](https://docs.apiseven.com/api7-gateway/configure-and-manage/configure-data-plane.md): API7 网关数据面的详细配置参考，基于 config-default.yaml 结构。 #### data-plane-resilience 为 API7 网关数据面节点配置备用存储，使其在控制面长时间中断时仍能重启并继续运行。 - [数据面弹性](https://docs.apiseven.com/api7-gateway/configure-and-manage/data-plane-resilience.md): 为 API7 网关数据面节点配置备用存储，使其在控制面长时间中断时仍能重启并继续运行。 #### deployment-scenarios - [API7 网关多可用区部署](https://docs.apiseven.com/api7-gateway/configure-and-manage/deployment-scenarios/multi-az-deployment.md): 用于跨多个可用区部署 API7 网关的配置和架构，以实现高可用性和容错能力。 - [多区域部署模式](https://docs.apiseven.com/api7-gateway/configure-and-manage/deployment-scenarios/multi-region-deployment.md): 跨多个地理区域部署 API7 网关以实现全球覆盖和灾难恢复的架构和注意事项。 #### high-availability-data-plane 设计具有多个节点、健康检查和负载均衡器故障转移的高可用 API7 网关数据面。 - [数据面高可用性](https://docs.apiseven.com/api7-gateway/configure-and-manage/high-availability-data-plane.md): 设计具有多个节点、健康检查和负载均衡器故障转移的高可用 API7 网关数据面。 #### labels 使用标签组织和筛选 API7 网关资源，通过附加到网关组、服务、路由和消费者等实体的键值元数据，按团队、环境和应用进行分类。 - [标签](https://docs.apiseven.com/api7-gateway/configure-and-manage/labels.md): 使用标签组织和筛选 API7 网关资源，通过附加到网关组、服务、路由和消费者等实体的键值元数据，按团队、环境和应用进行分类。 #### license-management 管理 API7 网关许可证，了解生产与非生产 CPU 核心数额度和许可证状态，并配置许可证文件路径以实现自动化部署。 - [许可证管理](https://docs.apiseven.com/api7-gateway/configure-and-manage/license-management.md): 管理 API7 网关许可证，了解生产与非生产 CPU 核心数额度和许可证状态，并配置许可证文件路径以实现自动化部署。 #### performance-benchmark 了解 API7 网关在 AWS EKS 和单主机环境中的性能基准结果，以及复现基准测试的方法和优化建议。 - [性能基准](https://docs.apiseven.com/api7-gateway/configure-and-manage/performance-benchmark.md): 了解 API7 网关在 AWS EKS 和单主机环境中的性能基准结果，以及复现基准测试的方法和优化建议。 #### production-best-practices 在生产中管理 API7 网关的操作最佳实践，包括 GitOps、变更管理和灾难恢复。 - [生产最佳实践](https://docs.apiseven.com/api7-gateway/configure-and-manage/production-best-practices.md): 在生产中管理 API7 网关的操作最佳实践，包括 GitOps、变更管理和灾难恢复。 #### run-in-production API7 网关的上线前检查清单和部署指南，用于确保生产环境稳定且安全。 - [在生产环境中运行](https://docs.apiseven.com/api7-gateway/configure-and-manage/run-in-production.md): API7 网关的上线前检查清单和部署指南，用于确保生产环境稳定且安全。 #### scale-data-plane 水平扩展 API7 网关数据面节点以提高吞吐量并为高可用性部署做好准备。 - [扩缩容数据面](https://docs.apiseven.com/api7-gateway/configure-and-manage/scale-data-plane.md): 水平扩展 API7 网关数据面节点以提高吞吐量并为高可用性部署做好准备。 #### shared-dict-sizing 根据部署规模为 API7 网关的指标、服务发现、开发者门户和链路追踪共享内存合理分配容量，避免内存溢出导致数据丢失。 - [共享内存容量规划](https://docs.apiseven.com/api7-gateway/configure-and-manage/shared-dict-sizing.md): 根据部署规模为 API7 网关的指标、服务发现、开发者门户和链路追踪共享内存合理分配容量，避免内存溢出导致数据丢失。 #### telemetry-opt-out 配置数据面和控制面之间的遥测数据传输，包括压缩级别以及如何禁用遥测。 - [优化遥测数据传输](https://docs.apiseven.com/api7-gateway/configure-and-manage/telemetry-opt-out.md): 配置数据面和控制面之间的遥测数据传输，包括压缩级别以及如何禁用遥测。 #### user-management 管理 API7 企业版中的用户、角色和权限策略。 - [用户管理](https://docs.apiseven.com/api7-gateway/configure-and-manage/user-management.md): 管理 API7 企业版中的用户、角色和权限策略。 ### developer-portal #### deploy - [配置开发者门户](https://docs.apiseven.com/api7-gateway/developer-portal/deploy/configure-portal.md): 配置开发者门户设置，包括公共访问、门户令牌、内置身份认证和 SCIM 预配。 - [定制开发者门户](https://docs.apiseven.com/api7-gateway/developer-portal/deploy/customize-portal.md): 使用 API7 Developer Portal Boilerplate 自定义开发者门户的品牌、主题、身份认证提供商和功能。 - [部署开发者门户](https://docs.apiseven.com/api7-gateway/developer-portal/deploy/deploy-portal.md): 在 Docker Compose 或 Kubernetes 上部署 API7 开发者门户的两个官方镜像（门户 API 后端和面向开发者的前端），并将其连接到 API7 控制面。 #### get-started 从 Docker Compose 安装包启动本地 API7 开发者门户、注册开发者，并验证对 API Hub 的访问。 - [启动本地开发者门户](https://docs.apiseven.com/api7-gateway/developer-portal/get-started.md): 从 Docker Compose 安装包启动本地 API7 开发者门户、注册开发者，并验证对 API Hub 的访问。 #### guides - [浏览 API](https://docs.apiseven.com/api7-gateway/developer-portal/guides/browse-apis.md): 在开发者门户的 API Hub 中发现和探索可用的 API 产品。 - [创建应用程序](https://docs.apiseven.com/api7-gateway/developer-portal/guides/create-application.md): 在开发者门户中创建一个应用程序来对你的 API 订阅和凭证进行分组。 - [管理凭证](https://docs.apiseven.com/api7-gateway/developer-portal/guides/manage-credentials.md): 在开发者门户中创建、查看、重新生成和删除用于对 API 请求进行身份认证的凭证。 - [管理组织](https://docs.apiseven.com/api7-gateway/developer-portal/guides/manage-organization.md): 在开发者门户中管理组织，包括邀请成员、分配角色以及在组织之间切换。 - [注册与登录](https://docs.apiseven.com/api7-gateway/developer-portal/guides/register-and-login.md): 创建开发者账户并使用电子邮件/密码、SSO 或组织邀请登录开发者门户。 - [订阅 API](https://docs.apiseven.com/api7-gateway/developer-portal/guides/subscribe-to-api.md): 为你的应用程序订阅 API 产品，以通过开发者门户获得使用 API 的访问权限。 - [调试 API](https://docs.apiseven.com/api7-gateway/developer-portal/guides/try-api.md): 使用内置的 Try It Out 功能直接从开发者门户测试 API 端点。 #### key-concepts - [API 产品](https://docs.apiseven.com/api7-gateway/developer-portal/key-concepts/api-products.md): 了解开发者门户中的 API 产品，包括产品类型、可见性设置、身份认证选项和发布生命周期。 - [应用程序](https://docs.apiseven.com/api7-gateway/developer-portal/key-concepts/applications.md): 了解开发者门户中的应用程序，以及如何按特定项目或用例对订阅和凭证进行分组。 - [凭证](https://docs.apiseven.com/api7-gateway/developer-portal/key-concepts/credentials.md): 了解开发者门户中的凭证，包括支持的身份认证类型（API Key（API 密钥）身份认证、基本身份认证和 OAuth/DCR）以及凭证生命周期管理。 - [开发者](https://docs.apiseven.com/api7-gateway/developer-portal/key-concepts/developers.md): 了解开发者门户中的开发者，包括注册方式、账户状态，以及开发者与消费者之间的区别。 - [订阅](https://docs.apiseven.com/api7-gateway/developer-portal/key-concepts/subscriptions.md): 了解开发者门户中的订阅，包括审批工作流程、状态转换和自动审批配置。 #### manage - [配置动态客户端注册（DCR）](https://docs.apiseven.com/api7-gateway/developer-portal/manage/configure-dcr.md): 配置 DCR 提供商以使开发者能够通过开发者门户注册 OAuth 2.0 客户端。 - [使用 Okta 为自定义开发者门户配置 SCIM 预配](https://docs.apiseven.com/api7-gateway/developer-portal/manage/configure-scim.md): 使用 Okta 为基于 API7 Developer Portal Boilerplate 的自定义开发者门户配置 SCIM 预配。 - [为开发者门户配置 SSO](https://docs.apiseven.com/api7-gateway/developer-portal/manage/configure-sso.md): 使用 OIDC、SAML、LDAP 或 CAS 身份提供商为开发者门户配置单点登录（SSO）。 - [管理 API 产品](https://docs.apiseven.com/api7-gateway/developer-portal/manage/manage-api-products.md): 在 Provider Portal 中创建、配置、发布和管理 API 产品，以供开发者通过开发者门户使用。 - [管理应用程序](https://docs.apiseven.com/api7-gateway/developer-portal/manage/manage-applications.md): 在开发者门户中管理开发者应用程序，包括生命周期、结构以及如何以编程方式调用开发者门户后端。 - [管理开发者](https://docs.apiseven.com/api7-gateway/developer-portal/manage/manage-developers.md): 使用 Provider Portal Admin API 和独立的开发者门户后端管理开发者账户，包括列出、创建、审批注册和删除开发者。 - [管理订阅](https://docs.apiseven.com/api7-gateway/developer-portal/manage/manage-subscriptions.md): 在 Provider Portal 中管理 API 产品订阅，包括批准、拒绝和取消订阅请求。 #### overview 了解 API7 开发者门户，这是一个供 API 提供商发布 API 产品，以及供开发者发现、订阅和使用 API 的平台。 - [开发者门户简介](https://docs.apiseven.com/api7-gateway/developer-portal/overview.md): 了解 API7 开发者门户，这是一个供 API 提供商发布 API 产品，以及供开发者发现、订阅和使用 API 的平台。 ### enterprise-features #### alerts-and-contact-points 了解 API7 网关中的告警和联系人，以及如何监控异常并及时发送通知。 - [告警和联系人](https://docs.apiseven.com/api7-gateway/enterprise-features/alerts-and-contact-points.md): 了解 API7 网关中的告警和联系人，以及如何监控异常并及时发送通知。 #### anonymous-consumers 了解 API7 网关中的匿名消费者，允许未经过身份认证的用户访问 API，同时保障系统安全。 - [匿名消费者](https://docs.apiseven.com/api7-gateway/enterprise-features/anonymous-consumers.md): 了解 API7 网关中的匿名消费者，允许未经过身份认证的用户访问 API，同时保障系统安全。 #### api-portal 了解 API7 网关中的 API 门户，为开发者提供集中访问和管理 API 的平台。 - [API 门户](https://docs.apiseven.com/api7-gateway/enterprise-features/api-portal.md): 了解 API7 网关中的 API 门户，为开发者提供集中访问和管理 API 的平台。 #### audit-logging 了解 API7 网关中的审计日志，以及如何记录用户操作和配置变更。 - [审计日志](https://docs.apiseven.com/api7-gateway/enterprise-features/audit-logging.md): 了解 API7 网关中的审计日志，以及如何记录用户操作和配置变更。 #### compliance 了解 API7 网关的合规能力，帮助组织满足监管要求并遵循安全标准。 - [合规](https://docs.apiseven.com/api7-gateway/enterprise-features/compliance.md): 了解 API7 网关的合规能力，帮助组织满足监管要求并遵循安全标准。 #### credentials 了解 API7 网关中的凭证，安全地认证用户身份，并简化凭证管理和轮换。 - [凭证](https://docs.apiseven.com/api7-gateway/enterprise-features/credentials.md): 了解 API7 网关中的凭证，安全地认证用户身份，并简化凭证管理和轮换。 #### custom-plugins 了解 API7 网关中的自定义插件，通过定制扩展满足特定业务需求。 - [自定义插件](https://docs.apiseven.com/api7-gateway/enterprise-features/custom-plugins.md): 了解 API7 网关中的自定义插件，通过定制扩展满足特定业务需求。 #### dashboard-sso 了解 API7 网关中的单点登录（SSO），使用现有凭证进行身份认证，轻松访问控制台。 - [控制台单点登录](https://docs.apiseven.com/api7-gateway/enterprise-features/dashboard-sso.md): 了解 API7 网关中的单点登录（SSO），使用现有凭证进行身份认证，轻松访问控制台。 #### gateway-groups 了解 API7 网关中的网关组，集中管理共享配置的多个 API 网关实例。 - [网关组](https://docs.apiseven.com/api7-gateway/enterprise-features/gateway-groups.md): 了解 API7 网关中的网关组，集中管理共享配置的多个 API 网关实例。 #### high-availability 了解 API7 网关中的高可用性，为关键业务应用持续提供可靠服务。 - [高可用性](https://docs.apiseven.com/api7-gateway/enterprise-features/high-availability.md): 了解 API7 网关中的高可用性，为关键业务应用持续提供可靠服务。 #### organization-and-rbac 了解 API7 网关中的组织管理和 RBAC，实现细粒度权限管理。 - [组织和 RBAC](https://docs.apiseven.com/api7-gateway/enterprise-features/organization-and-rbac.md): 了解 API7 网关中的组织管理和 RBAC，实现细粒度权限管理。 #### overview 了解 API7 网关区别于开源 Apache APISIX 的企业级特性，包括集中式管理、RBAC、审计日志和专业支持。 - [企业功能概览](https://docs.apiseven.com/api7-gateway/enterprise-features/overview.md): 了解 API7 网关区别于开源 Apache APISIX 的企业级特性，包括集中式管理、RBAC、审计日志和专业支持。 #### permission-policies-and-boundaries 了解 API7 网关中的权限策略和权限边界，定义用户访问级别，增强系统安全性。 - [权限策略和权限边界](https://docs.apiseven.com/api7-gateway/enterprise-features/permission-policies-and-boundaries.md): 了解 API7 网关中的权限策略和权限边界，定义用户访问级别，增强系统安全性。 #### secret-providers 了解 API7 网关中的密钥提供方，使用第三方工具存储敏感数据，增强系统安全性。 - [密钥提供方](https://docs.apiseven.com/api7-gateway/enterprise-features/secret-providers.md): 了解 API7 网关中的密钥提供方，使用第三方工具存储敏感数据，增强系统安全性。 #### security-hardening 了解 API7 网关中的安全加固能力，保护 API 基础设施免受威胁和漏洞影响。 - [安全加固](https://docs.apiseven.com/api7-gateway/enterprise-features/security-hardening.md): 了解 API7 网关中的安全加固能力，保护 API 基础设施免受威胁和漏洞影响。 ### getting-started #### add-gateway-group 按照本教程学习如何在 API7 企业版中新增网关组，从而实现对 API 网关实例的有效管理和组织。 - [新增网关组](https://docs.apiseven.com/api7-gateway/getting-started/add-gateway-group.md): 按照本教程学习如何在 API7 企业版中新增网关组，从而实现对 API 网关实例的有效管理和组织。 #### add-gateway-instance 按照本教程了解如何将网关实例新增到你的 API7 企业版网关组中，确保高效的路由和 API 处理。 - [新增网关实例](https://docs.apiseven.com/api7-gateway/getting-started/add-gateway-instance.md): 按照本教程了解如何将网关实例新增到你的 API7 企业版网关组中，确保高效的路由和 API 处理。 #### audit-logging 按照本教程在 API7 企业版中使用审计日志功能，实现对用户活动的详细追踪，并提升安全性和合规性。 - [使用审计日志追踪操作员活动](https://docs.apiseven.com/api7-gateway/getting-started/audit-logging.md): 按照本教程在 API7 企业版中使用审计日志功能，实现对用户活动的详细追踪，并提升安全性和合规性。 #### canary-upstream 按照本教程在 API7 企业版中配置金丝雀流量转移，通过逐步路由流量来安全地测试新的上游。 - [配置金丝雀流量转移](https://docs.apiseven.com/api7-gateway/getting-started/canary-upstream.md): 按照本教程在 API7 企业版中配置金丝雀流量转移，通过逐步路由流量来安全地测试新的上游。 #### create-custom-role 按照本教程在 API7 企业版中创建自定义角色，从而实现针对特定需求量身定制的细粒度权限管理。 - [创建自定义角色](https://docs.apiseven.com/api7-gateway/getting-started/create-custom-role.md): 按照本教程在 API7 企业版中创建自定义角色，从而实现针对特定需求量身定制的细粒度权限管理。 #### install-api7-ee 按照本教程在 Docker 上安装 API7 企业版，包括用于管理 API 网关和确保无缝设置的基本组件。 - [安装 API7 企业版](https://docs.apiseven.com/api7-gateway/getting-started/install-api7-ee.md): 按照本教程在 Docker 上安装 API7 企业版，包括用于管理 API 网关和确保无缝设置的基本组件。 #### k8s-service-discovery 按照本指南在 API7 企业版中配置 Kubernetes 服务发现，以支持动态探测 Kubernetes 集群中的上游节点。 - [配置 Kubernetes 服务发现](https://docs.apiseven.com/api7-gateway/getting-started/k8s-service-discovery.md): 按照本指南在 API7 企业版中配置 Kubernetes 服务发现，以支持动态探测 Kubernetes 集群中的上游节点。 #### launch-your-first-api 学习如何在 API7 企业版上发布并验证你的第一个 API，包括创建服务、路由，以及通过 HTTP 请求进行测试。 - [发布你的第一个 API](https://docs.apiseven.com/api7-gateway/getting-started/launch-your-first-api.md): 学习如何在 API7 企业版上发布并验证你的第一个 API，包括创建服务、路由，以及通过 HTTP 请求进行测试。 #### learn-more 了解 API7 产品系列、API7 企业版与 Apache APISIX 的关系，以及它们如何融入你的 API 管理策略。 - [深入了解 API7 产品和 APISIX](https://docs.apiseven.com/api7-gateway/getting-started/learn-more.md): 了解 API7 产品系列、API7 企业版与 Apache APISIX 的关系，以及它们如何融入你的 API 管理策略。 #### license 了解如何获取和续订 API7 企业版许可证，以确保你可以持续访问各项功能和服务。 - [续订许可证](https://docs.apiseven.com/api7-gateway/getting-started/license.md): 了解如何获取和续订 API7 企业版许可证，以确保你可以持续访问各项功能和服务。 #### management-options 比较 API7 网关控制台、Admin API、ADC、a7 CLI 和 API7-MCP，为交互式操作、自动化、GitOps 和 AI 客户端选择合适的方式。 - [管理方式](https://docs.apiseven.com/api7-gateway/getting-started/management-options.md): 比较 API7 网关控制台、Admin API、ADC、a7 CLI 和 API7-MCP，为交互式操作、自动化、GitOps 和 AI 客户端选择合适的方式。 #### overview 开始使用 API7 网关。了解平台组件、它们的协作方式，并为你的使用场景选择合适路径。 - [API7 网关概览](https://docs.apiseven.com/api7-gateway/getting-started/overview.md): 开始使用 API7 网关。了解平台组件、它们的协作方式，并为你的使用场景选择合适路径。 #### quick-start 使用 Docker Compose 在本地运行 API7 网关，并在 10 分钟内代理首个 API 请求。 - [快速开始](https://docs.apiseven.com/api7-gateway/getting-started/quick-start.md): 使用 Docker Compose 在本地运行 API7 网关，并在 10 分钟内代理首个 API 请求。 #### rbac 按照本教程在 API7 企业版中管理基于角色的访问控制（RBAC），通过角色和权限策略简化用户权限管理。 - [更新用户角色](https://docs.apiseven.com/api7-gateway/getting-started/rbac.md): 按照本教程在 API7 企业版中管理基于角色的访问控制（RBAC），通过角色和权限策略简化用户权限管理。 #### tutorial-proxying-api-requests 通过动手实践，学习代理 API 请求、使用 `key-auth` 插件添加身份认证，以及启用 `limit-count` 插件实施限流。 - [教程：通过插件代理和管理 API 请求](https://docs.apiseven.com/api7-gateway/getting-started/tutorial-proxying-api-requests.md): 通过动手实践，学习代理 API 请求、使用 `key-auth` 插件添加身份认证，以及启用 `limit-count` 插件实施限流。 ### how-to-guides #### api-security - [配置 Basic 身份认证](https://docs.apiseven.com/api7-gateway/how-to-guides/api-security/basic-auth.md): 了解如何要求客户端在 HTTP Authorization 请求头中提供标准用户名和密码来保护 API。 - [配置数据脱敏](https://docs.apiseven.com/api7-gateway/how-to-guides/api-security/data-masking.md): 使用 data-mask 插件，在请求数据写入访问日志和日志插件输出前对敏感字段进行遮盖、替换或移除，帮助满足 GDPR、HIPAA 和 PCI-DSS 要求。 - [将外部认证用户信息转发到上游](https://docs.apiseven.com/api7-gateway/how-to-guides/api-security/forward-auth-user-info.md): 将 OpenID Connect 或 SAML 路由中的已认证用户信息作为请求头或消费者名称转发到上游服务。 - [配置 HMAC 身份认证](https://docs.apiseven.com/api7-gateway/how-to-guides/api-security/hmac-auth.md): 了解如何在 API7 企业版中使用基于哈希的消息认证码（HMAC）对请求签名，从而保护 API。 - [配置 JWT 身份认证](https://docs.apiseven.com/api7-gateway/how-to-guides/api-security/jwt-auth.md): 了解如何在 API7 企业版中使用 JSON Web Token（JWT）实现无状态身份认证，以保护 API。 - [配置 Key 身份认证](https://docs.apiseven.com/api7-gateway/how-to-guides/api-security/key-auth.md): 了解如何要求客户端在请求头或查询字符串中提供唯一 API Key（API 密钥）来保护 API。 #### ops - [配置就绪和存活探针](https://docs.apiseven.com/api7-gateway/how-to-guides/ops/configure-readiness-probe.md): 为 Kubernetes、Docker 和其他非 Helm 部署中的 API7 网关数据面配置就绪和存活检查。 - [创建自定义角色](https://docs.apiseven.com/api7-gateway/how-to-guides/ops/create-custom-role.md): 通过定义权限策略、将其附加到角色并将角色分配给用户，在 API7 网关中创建自定义角色。 - [设计自定义角色体系](https://docs.apiseven.com/api7-gateway/how-to-guides/ops/design-custom-role-system.md): 通过组合角色、权限策略、标签和权限边界，在 API7 网关中设计可扩展的自定义角色体系。 - [管理网关组](https://docs.apiseven.com/api7-gateway/how-to-guides/ops/multi-gateway-group.md): 了解如何创建和管理多个网关组，以便按环境或团队组织和隔离 API 流量。 - [配置密钥管理](https://docs.apiseven.com/api7-gateway/how-to-guides/ops/secret-manager.md): 了解如何配置密钥提供方，并在 API7 企业版中引用外部密钥，避免在网关资源中硬编码敏感值。 #### overview API7 网关常见任务和工作流的实用操作指南。 - [操作指南](https://docs.apiseven.com/api7-gateway/how-to-guides/overview.md): API7 网关常见任务和工作流的实用操作指南。 #### plugin-development - [插件开发最佳实践](https://docs.apiseven.com/api7-gateway/how-to-guides/plugin-development/best-practices.md): 使用内置核心库代替底层 OpenResty API，通过 Schema 校验配置，并选择正确的阶段和优先级，编写正确、高效且易维护的自定义 Lua 插件。 - [开发自定义 Lua 插件](https://docs.apiseven.com/api7-gateway/how-to-guides/plugin-development/custom-lua-plugins.md): 了解如何为 API7 网关开发、注册和测试自定义 Lua 插件。 - [Serverless 函数还是自定义插件](https://docs.apiseven.com/api7-gateway/how-to-guides/plugin-development/serverless-or-custom-plugins.md): 比较内置 serverless-function 插件与自定义 Lua 插件，并选择适合在 API7 网关中运行自有 Lua 逻辑的方式。 #### protocol-proxy - [配置 GraphQL 代理](https://docs.apiseven.com/api7-gateway/how-to-guides/protocol-proxy/graphql-proxy.md): 了解如何通过 API7 网关代理 GraphQL API，以及何时添加支持 GraphQL 的插件进行限流和缓存。 - [配置 gRPC 代理](https://docs.apiseven.com/api7-gateway/how-to-guides/protocol-proxy/grpc-proxy.md): 了解如何配置 API7 企业版代理 gRPC 流量，包括 REST 到 gRPC 转码，以及为浏览器客户端启用 gRPC-Web 支持。 - [配置 TCP/UDP 代理](https://docs.apiseven.com/api7-gateway/how-to-guides/protocol-proxy/tcp-udp-proxy.md): 配置 API7 网关代理 TCP 和 UDP（第 4 层）流量到数据库、消息队列和自定义协议等上游服务。 - [配置 WebSocket 代理](https://docs.apiseven.com/api7-gateway/how-to-guides/protocol-proxy/websocket-proxy.md): 了解如何在 API7 企业版中为路由启用和配置 WebSocket 代理，以处理长连接和双向通信。 #### traffic-management - [实现蓝绿发布](https://docs.apiseven.com/api7-gateway/how-to-guides/traffic-management/blue-green-deployment.md): 使用 API7 网关实现蓝绿发布，在两个上游环境之间零停机切换流量。 - [实施灰度发布](https://docs.apiseven.com/api7-gateway/how-to-guides/traffic-management/canary-release.md): 了解如何使用 traffic-split 插件逐步将流量迁移到新版后端服务。 - [配置 CORS](https://docs.apiseven.com/api7-gateway/how-to-guides/traffic-management/cors.md): 了解如何为 API 配置跨源资源共享（CORS），允许或限制来自不同域的访问。 - [配置故障注入](https://docs.apiseven.com/api7-gateway/how-to-guides/traffic-management/fault-injection.md): 了解如何通过注入 HTTP 错误和响应延迟来测试应用的韧性。 - [条件式禁用全局插件](https://docs.apiseven.com/api7-gateway/how-to-guides/traffic-management/global-plugin-exemption.md): 使用路由标签和 _meta.filter 机制，为特定路由有条件地跳过全局插件执行。 - [配置上游健康检查](https://docs.apiseven.com/api7-gateway/how-to-guides/traffic-management/health-check.md): 了解如何为上游服务配置主动和被动健康检查，以确保高可用。 - [配置代理缓存](https://docs.apiseven.com/api7-gateway/how-to-guides/traffic-management/proxy-cache.md): 了解如何在网关处缓存响应，以提高 API 性能并降低上游负载。 - [配置代理镜像](https://docs.apiseven.com/api7-gateway/how-to-guides/traffic-management/proxy-mirror.md): 了解如何复制一定比例的真实生产流量并发送到辅助服务，以进行测试和验证。 - [改写代理请求](https://docs.apiseven.com/api7-gateway/how-to-guides/traffic-management/proxy-rewrite.md): 了解如何在将请求代理到上游服务前修改请求 URI、方法和请求头。 - [配置限流](https://docs.apiseven.com/api7-gateway/how-to-guides/traffic-management/rate-limiting.md): 了解如何为 API 配置简单和高级限流，以防止滥用并确保公平使用。 - [提升多网关实例下的限流精度](https://docs.apiseven.com/api7-gateway/how-to-guides/traffic-management/rate-limiting-accuracy.md): 理解多网关实例批量同步计数器时限流误差的来源，以及滑动窗口为何能将长期误差收敛到接近零。 - [配置响应改写](https://docs.apiseven.com/api7-gateway/how-to-guides/traffic-management/response-rewrite.md): 了解如何在向客户端返回响应之前修改状态码、响应头和响应体内容。 ### install #### deploy-high-availability 以高可用配置部署 API7 网关控制面和数据面，消除单点故障。 - [部署高可用环境](https://docs.apiseven.com/api7-gateway/install/deploy-high-availability.md): 以高可用配置部署 API7 网关控制面和数据面，消除单点故障。 #### deploy-on-kubernetes 使用 Helm 在 Kubernetes 上部署 API7 企业版，包括控制面安装、使用 mTLS 配置数据面，以及 AWS EKS、GCP GKE 和 Azure AKS 专用指南。 - [在 Kubernetes 上部署 API7 企业版](https://docs.apiseven.com/api7-gateway/install/deploy-on-kubernetes.md): 使用 Helm 在 Kubernetes 上部署 API7 企业版，包括控制面安装、使用 mTLS 配置数据面，以及 AWS EKS、GCP GKE 和 Azure AKS 专用指南。 #### deploy-on-openshift 使用正确的安全上下文约束（SCC）、服务账号和 Helm Chart 配置，在 Red Hat OpenShift 上部署 API7 网关。 - [在 OpenShift 上部署](https://docs.apiseven.com/api7-gateway/install/deploy-on-openshift.md): 使用正确的安全上下文约束（SCC）、服务账号和 Helm Chart 配置，在 Red Hat OpenShift 上部署 API7 网关。 #### deploy-with-docker-compose 使用 Docker Compose 通过在线快速安装脚本、离线部署包或可自定义的手动部署，安装完整的 API7 网关环境。 - [使用 Docker Compose 部署](https://docs.apiseven.com/api7-gateway/install/deploy-with-docker-compose.md): 使用 Docker Compose 通过在线快速安装脚本、离线部署包或可自定义的手动部署，安装完整的 API7 网关环境。 #### deploy-with-rpm 在 RHEL、Rocky Linux、AlmaLinux、CentOS 8/9 等 Red Hat 系 Linux 系统中，通过离线 RPM 包部署 API7 网关，并使用 systemd 管理控制面和数据面服务。 - [使用离线 RPM 包部署](https://docs.apiseven.com/api7-gateway/install/deploy-with-rpm.md): 在 RHEL、Rocky Linux、AlmaLinux、CentOS 8/9 等 Red Hat 系 Linux 系统中，通过离线 RPM 包部署 API7 网关，并使用 systemd 管理控制面和数据面服务。 #### installation-faq 安装过程中的常见问题和故障排查方法。 - [安装常见问题](https://docs.apiseven.com/api7-gateway/install/installation-faq.md): 安装过程中的常见问题和故障排查方法。 #### installation-packages 用于安装 API7 网关的容器镜像、Helm Chart 和 CLI 工具，包括网关、DP Manager、开发者门户和集成控制面镜像的官方 Docker Hub 仓库。 - [安装包](https://docs.apiseven.com/api7-gateway/install/installation-packages.md): 用于安装 API7 网关的容器镜像、Helm Chart 和 CLI 工具，包括网关、DP Manager、开发者门户和集成控制面镜像的官方 Docker Hub 仓库。 #### overview 比较 API7 网关在生产、评估和隔离网络环境中的 Kubernetes、Docker Compose 与安装包部署选项。 - [在本地环境安装 API7 网关](https://docs.apiseven.com/api7-gateway/install/overview.md): 比较 API7 网关在生产、评估和隔离网络环境中的 Kubernetes、Docker Compose 与安装包部署选项。 #### rpm-from-docker 当控制台尚未生成原生 RPM 数据面脚本时，可从 Docker 脚本中提取连接参数，并将 api7-gateway RPM 接入控制面。 - [从 Docker 脚本接入 RPM 数据面](https://docs.apiseven.com/api7-gateway/install/rpm-from-docker.md): 当控制台尚未生成原生 RPM 数据面脚本时，可从 Docker 脚本中提取连接参数，并将 api7-gateway RPM 接入控制面。 #### rpm-quickstart 使用 RPM 包内置的 quickstart.sh，在单台主机上快速启动 API7 网关控制面，适用于评估和概念验证（PoC）。 - [单机 RPM 快速试用](https://docs.apiseven.com/api7-gateway/install/rpm-quickstart.md): 使用 RPM 包内置的 quickstart.sh，在单台主机上快速启动 API7 网关控制面，适用于评估和概念验证（PoC）。 #### supported-versions-and-interoperability API7 网关组件和基础设施的版本兼容性矩阵。 - [支持的版本和互操作性](https://docs.apiseven.com/api7-gateway/install/supported-versions-and-interoperability.md): API7 网关组件和基础设施的版本兼容性矩阵。 #### system-requirements 安装 API7 企业版所需的硬件、操作系统和网络要求。 - [系统要求](https://docs.apiseven.com/api7-gateway/install/system-requirements.md): 安装 API7 企业版所需的硬件、操作系统和网络要求。 ### introduction 探索 API7 企业版，这是一个基于 Apache APISIX 构建的 API 网关，专为企业需求量身定制，提供全生命周期的 API 管理。 - [概览](https://docs.apiseven.com/api7-gateway/introduction.md): 探索 API7 企业版，这是一个基于 Apache APISIX 构建的 API 网关，专为企业需求量身定制，提供全生命周期的 API 管理。 #### architecture 探索 API7 企业版的架构，这是一个基于 Apache APISIX 的云原生 API 网关，具有可扩展的数据平面和控制平面，可满足企业需求。 - [架构](https://docs.apiseven.com/api7-gateway/introduction/architecture.md): 探索 API7 企业版的架构，这是一个基于 Apache APISIX 的云原生 API 网关，具有可扩展的数据平面和控制平面，可满足企业需求。 ### key-concepts #### api-portal API7 门户（API Portal）是一个集中式的在线平台，是 API 提供者与开发者之间的桥梁。 - [API 门户](https://docs.apiseven.com/api7-gateway/key-concepts/api-portal.md): API7 门户（API Portal）是一个集中式的在线平台，是 API 提供者与开发者之间的桥梁。 #### api-products 了解 API7 企业版如何通过 API 产品组织和管理 API，并向不同开发者群体提供适合其使用场景的 API 集合。 - [API 产品](https://docs.apiseven.com/api7-gateway/key-concepts/api-products.md): 了解 API7 企业版如何通过 API 产品组织和管理 API，并向不同开发者群体提供适合其使用场景的 API 集合。 #### architecture 深入了解 API7 企业版控制面与数据面解耦的架构。 - [架构](https://docs.apiseven.com/api7-gateway/key-concepts/architecture.md): 深入了解 API7 企业版控制面与数据面解耦的架构。 #### certificates 了解 API7 企业版如何使用 TLS 和 mTLS，在客户端、API 网关和后端服务之间建立安全通信。 - [证书](https://docs.apiseven.com/api7-gateway/key-concepts/certificates.md): 了解 API7 企业版如何使用 TLS 和 mTLS，在客户端、API 网关和后端服务之间建立安全通信。 #### consumers 了解 API7 企业版中的消费者如何用于身份认证、访问控制和安全的 API 请求处理。 - [消费者](https://docs.apiseven.com/api7-gateway/key-concepts/consumers.md): 了解 API7 企业版中的消费者如何用于身份认证、访问控制和安全的 API 请求处理。 #### consumers-and-credentials 使用消费者和凭证进行身份管理与身份认证。 - [消费者和凭证](https://docs.apiseven.com/api7-gateway/key-concepts/consumers-and-credentials.md): 使用消费者和凭证进行身份管理与身份认证。 #### developers 了解开发者在 API7 企业版中的角色，使他们能够通过 API 门户有效地发现、学习和集成 API。 - [开发者](https://docs.apiseven.com/api7-gateway/key-concepts/developers.md): 了解开发者在 API7 企业版中的角色，使他们能够通过 API 门户有效地发现、学习和集成 API。 #### gateway-groups 用于环境隔离和配置管理的数据面实例逻辑分组。 - [网关组](https://docs.apiseven.com/api7-gateway/key-concepts/gateway-groups.md): 用于环境隔离和配置管理的数据面实例逻辑分组。 #### overview 介绍 API7 企业版中的核心抽象和实体。 - [核心概念概览](https://docs.apiseven.com/api7-gateway/key-concepts/overview.md): 介绍 API7 企业版中的核心抽象和实体。 #### plugins 用于在 API7 网关中拦截并修改 API 流量的模块化组件。 - [插件](https://docs.apiseven.com/api7-gateway/key-concepts/plugins.md): 用于在 API7 网关中拦截并修改 API 流量的模块化组件。 #### roles-and-permission-policies 了解 API7 企业版中的角色和权限策略，实现细粒度的访问控制和用户管理，确保 API 操作的安全性。 - [角色与权限策略](https://docs.apiseven.com/api7-gateway/key-concepts/roles-and-permission-policies.md): 了解 API7 企业版中的角色和权限策略，实现细粒度的访问控制和用户管理，确保 API 操作的安全性。 #### routes 了解 API7 企业版中的路由如何匹配 HTTP 请求、执行插件并将流量转发到后端服务。 - [路由](https://docs.apiseven.com/api7-gateway/key-concepts/routes.md): 了解 API7 企业版中的路由如何匹配 HTTP 请求、执行插件并将流量转发到后端服务。 #### secrets 了解如何在 API7 企业版中使用密钥对象和提供程序安全地管理敏感信息，以增强 API 数据保护。 - [密钥](https://docs.apiseven.com/api7-gateway/key-concepts/secrets.md): 了解如何在 API7 企业版中使用密钥对象和提供程序安全地管理敏感信息，以增强 API 数据保护。 #### service-discovery API7 网关中的动态上游解析，无需硬编码 IP，即可从 Kubernetes Service、Nacos 和 Consul 注册中心自动发现后端端点。 - [服务发现](https://docs.apiseven.com/api7-gateway/key-concepts/service-discovery.md): API7 网关中的动态上游解析，无需硬编码 IP，即可从 Kubernetes Service、Nacos 和 Consul 注册中心自动发现后端端点。 #### services 了解 API7 企业版中的服务如何组织路由、上游和插件配置，以简化 API 管理。 - [服务](https://docs.apiseven.com/api7-gateway/key-concepts/services.md): 了解 API7 企业版中的服务如何组织路由、上游和插件配置，以简化 API 管理。 #### services-and-routes 了解如何使用服务与路由对 API 流量进行分组和路由。 - [服务与路由](https://docs.apiseven.com/api7-gateway/key-concepts/services-and-routes.md): 了解如何使用服务与路由对 API 流量进行分组和路由。 #### snis 了解 API7 企业版如何通过服务器名称指示（SNI）让多个主机名共享 SSL 证书，从而提升安全性和管理效率。 - [SNI](https://docs.apiseven.com/api7-gateway/key-concepts/snis.md): 了解 API7 企业版如何通过服务器名称指示（SNI）让多个主机名共享 SSL 证书，从而提升安全性和管理效率。 #### ssl-certificates 了解 API7 网关如何管理 SSL/TLS 证书和终止安全连接。 - [SSL 证书](https://docs.apiseven.com/api7-gateway/key-concepts/ssl-certificates.md): 了解 API7 网关如何管理 SSL/TLS 证书和终止安全连接。 #### stream-routes 了解 API7 网关中用于代理 TCP 和 UDP（第 4 层）流量的四层路由，包括匹配规则、支持的插件以及与 Stream 服务的关系。 - [四层路由](https://docs.apiseven.com/api7-gateway/key-concepts/stream-routes.md): 了解 API7 网关中用于代理 TCP 和 UDP（第 4 层）流量的四层路由，包括匹配规则、支持的插件以及与 Stream 服务的关系。 #### upstreams 了解 API7 企业版中的上游如何组织后端服务，实现流量转发、负载均衡和故障转移。 - [上游](https://docs.apiseven.com/api7-gateway/key-concepts/upstreams.md): 了解 API7 企业版中的上游如何组织后端服务，实现流量转发、负载均衡和故障转移。 #### upstreams-and-load-balancing 后端目标定义，包括负载均衡算法和健康检查。 - [上游与负载均衡](https://docs.apiseven.com/api7-gateway/key-concepts/upstreams-and-load-balancing.md): 后端目标定义，包括负载均衡算法和健康检查。 ### observability #### alerts 配置 API7 网关告警策略和联系人，当网关离线、证书过期或错误率超过阈值时通过邮件或 Webhook 接收通知。 - [配置告警](https://docs.apiseven.com/api7-gateway/observability/alerts.md): 配置 API7 网关告警策略和联系人，当网关离线、证书过期或错误率超过阈值时通过邮件或 Webhook 接收通知。 #### consumer-label-based-logging 在 API7 网关访问日志中包含消费者标签，以便按消费者跟踪和分析流量。 - [在访问日志中包含消费者标签](https://docs.apiseven.com/api7-gateway/observability/consumer-label-based-logging.md): 在 API7 网关访问日志中包含消费者标签，以便按消费者跟踪和分析流量。 #### debug-sessions 了解网关处理单个请求时的完整行为，包括插件执行顺序、耗时和日志。你可以按需捕获，也可以在告警触发时自动捕获。 - [使用调试会话捕获请求链路](https://docs.apiseven.com/api7-gateway/observability/debug-sessions.md): 了解网关处理单个请求时的完整行为，包括插件执行顺序、耗时和日志。你可以按需捕获，也可以在告警触发时自动捕获。 #### kubernetes-error-log-forwarding 使用 Splunk OpenTelemetry Collector，将 Kubernetes 中 API7 网关容器的错误日志转发到 Splunk。 - [将 Kubernetes 错误日志发送到 Splunk](https://docs.apiseven.com/api7-gateway/observability/kubernetes-error-log-forwarding.md): 使用 Splunk OpenTelemetry Collector，将 Kubernetes 中 API7 网关容器的错误日志转发到 Splunk。 #### logging 了解 API7 网关生成的访问日志和错误日志，配置格式与详细程度，并将日志转发到集中式日志管理系统。 - [配置集中式日志记录](https://docs.apiseven.com/api7-gateway/observability/logging.md): 了解 API7 网关生成的访问日志和错误日志，配置格式与详细程度，并将日志转发到集中式日志管理系统。 #### metrics 通过控制台内置监控页面或抓取数据面公开的 Prometheus 端点，监控 API7 网关指标。 - [监控指标](https://docs.apiseven.com/api7-gateway/observability/metrics.md): 通过控制台内置监控页面或抓取数据面公开的 Prometheus 端点，监控 API7 网关指标。 #### splunk-integration 使用 HTTP Event Collector（HEC）日志插件，将 API7 网关访问日志发送到 Splunk。 - [将访问日志发送到 Splunk](https://docs.apiseven.com/api7-gateway/observability/splunk-integration.md): 使用 HTTP Event Collector（HEC）日志插件，将 API7 网关访问日志发送到 Splunk。 #### tracing 使用 OpenTelemetry 插件在 API7 网关中配置分布式追踪、OTLP Collector、采样策略和路由跨度，以可视化请求流并分析延迟瓶颈。 - [配置分布式追踪](https://docs.apiseven.com/api7-gateway/observability/tracing.md): 使用 OpenTelemetry 插件在 API7 网关中配置分布式追踪、OTLP Collector、采样策略和路由跨度，以可视化请求流并分析延迟瓶颈。 ### overview 了解基于 Apache APISIX 构建、面向云原生环境的动态高性能 API7 网关，包括其架构、功能和部署模型。 - [API7 网关](https://docs.apiseven.com/api7-gateway/overview.md): 了解基于 Apache APISIX 构建、面向云原生环境的动态高性能 API7 网关，包括其架构、功能和部署模型。 ### reference 查找 API7 网关的 API、CLI 工具、部署配置、安全控制和配置语法参考文档。 - [参考概览](https://docs.apiseven.com/api7-gateway/reference.md): 查找 API7 网关的 API、CLI 工具、部署配置、安全控制和配置语法参考文档。 #### a7-cli 使用单独安装的 a7 CLI，以交互方式、脚本或 API7 网关 Agent Skills 管理 API7 网关组和资源。 - [a7 CLI](https://docs.apiseven.com/api7-gateway/reference/a7-cli.md): 使用单独安装的 a7 CLI，以交互方式、脚本或 API7 网关 Agent Skills 管理 API7 网关组和资源。 #### adc 使用 API 声明式 CLI（ADC）以声明式方式管理 API7 网关配置。 - [ADC 参考](https://docs.apiseven.com/api7-gateway/reference/adc.md): 使用 API 声明式 CLI（ADC）以声明式方式管理 API7 网关配置。 #### alert-template 在 API7 网关中使用预定义变量自定义告警通知，从而在告警消息和电子邮件中实现动态内容。 - [告警变量与模板](https://docs.apiseven.com/api7-gateway/reference/alert-template.md): 在 API7 网关中使用预定义变量自定义告警通知，从而在告警消息和电子邮件中实现动态内容。 #### approval-variables 使用 API7 网关审批变量和当前模板值，自定义 API 产品订阅通知邮件内容和 Webhook 消息。 - [审批通知变量与模板](https://docs.apiseven.com/api7-gateway/reference/approval-variables.md): 使用 API7 网关审批变量和当前模板值，自定义 API 产品订阅通知邮件内容和 Webhook 消息。 #### built-in-variables 了解 API7 网关中可用的内置变量，包括 NGINX、APISIX 和自定义变量，这些变量可用于路由匹配、日志自定义和插件配置。 - [内置变量](https://docs.apiseven.com/api7-gateway/reference/built-in-variables.md): 了解 API7 网关中可用的内置变量，包括 NGINX、APISIX 和自定义变量，这些变量可用于路由匹配、日志自定义和插件配置。 #### configuration 了解 API7 网关中使用的配置文件，包括用于有效管理设置的默认和用户定义文件。 - [配置文件](https://docs.apiseven.com/api7-gateway/reference/configuration.md): 了解 API7 网关中使用的配置文件，包括用于有效管理设置的默认和用户定义文件。 #### environment-variables 了解如何在 API7 网关中使用环境变量配置消费者凭证、SSL 证书和插件。 - [环境变量](https://docs.apiseven.com/api7-gateway/reference/environment-variables.md): 了解如何在 API7 网关中使用环境变量配置消费者凭证、SSL 证书和插件。 #### expressions 了解如何在 API7 网关中使用表达式进行路由匹配、请求过滤和配置中的条件逻辑。 - [API7 表达式](https://docs.apiseven.com/api7-gateway/reference/expressions.md): 了解如何在 API7 网关中使用表达式进行路由匹配、请求过滤和配置中的条件逻辑。 #### hardening 了解在 API7 网关中保护敏感信息的做法，包括存储、加密和通信实践，以防御各种威胁。 - [安全加固参考](https://docs.apiseven.com/api7-gateway/reference/hardening.md): 了解在 API7 网关中保护敏感信息的做法，包括存储、加密和通信实践，以防御各种威胁。 #### helm-chart 了解如何查看 API7 网关 Helm Chart 配置值，以及 Helm 配置值如何渲染为网关配置。 - [Helm Chart](https://docs.apiseven.com/api7-gateway/reference/helm-chart.md): 了解如何查看 API7 网关 Helm Chart 配置值，以及 Helm 配置值如何渲染为网关配置。 #### obtain-dashboard-token 在 API7 控制台中创建令牌，并将其用于 API7 网关 Admin API 和 ADC 身份认证。 - [从控制台获取令牌](https://docs.apiseven.com/api7-gateway/reference/obtain-dashboard-token.md): 在 API7 控制台中创建令牌，并将其用于 API7 网关 Admin API 和 ADC 身份认证。 #### permission-policy-action-and-resource API7 网关权限策略中所有操作和 ARN 风格资源的完整参考，按命名空间（gateway、iam、portal）组织，用于构建最小权限策略。 - [权限策略操作和资源](https://docs.apiseven.com/api7-gateway/reference/permission-policy-action-and-resource.md): API7 网关权限策略中所有操作和 ARN 风格资源的完整参考，按命名空间（gateway、iam、portal）组织，用于构建最小权限策略。 #### permission-policy-examples 可直接调整的 API7 网关权限策略示例，按访问模式、服务与插件操作、IAM 与治理以及门户管理组织。 - [权限策略示例](https://docs.apiseven.com/api7-gateway/reference/permission-policy-examples.md): 可直接调整的 API7 网关权限策略示例，按访问模式、服务与插件操作、IAM 与治理以及门户管理组织。 ### release-notes 查看 API7 网关各版本的最新更新、功能、改进和缺陷修复。 - [更新日志](https://docs.apiseven.com/api7-gateway/release-notes.md): 查看 API7 网关各版本的最新更新、功能、改进和缺陷修复。 ### scalability #### autoscale-on-kubernetes 使用 Kubernetes 的 Horizontal Pod Autoscaler（HPA）自动扩缩容 API7 网关数据面 Pod，以应对流量变化。 - [在 Kubernetes 上自动扩缩容数据面](https://docs.apiseven.com/api7-gateway/scalability/autoscale-on-kubernetes.md): 使用 Kubernetes 的 Horizontal Pod Autoscaler（HPA）自动扩缩容 API7 网关数据面 Pod，以应对流量变化。 ### security-and-compliance #### access-control-lists 使用 API7 网关的 `consumer-restriction` 插件限制 API 访问。按消费者名称、消费者组 ID、服务 ID 或路由 ID 配置允许列表和拒绝列表，实现细粒度安全控制。 - [访问控制列表（ACL）](https://docs.apiseven.com/api7-gateway/security-and-compliance/access-control-lists.md): 使用 API7 网关的 `consumer-restriction` 插件限制 API 访问。按消费者名称、消费者组 ID、服务 ID 或路由 ID 配置允许列表和拒绝列表，实现细粒度安全控制。 #### audit-logs 通过详细的审计日志跟踪 API7 控制面中的所有管理变更。了解如何查看、管理和导出审计记录，满足安全与合规要求。 - [审计日志](https://docs.apiseven.com/api7-gateway/security-and-compliance/audit-logs.md): 通过详细的审计日志跟踪 API7 控制面中的所有管理变更。了解如何查看、管理和导出审计记录，满足安全与合规要求。 #### authenticate - [客户端 mTLS 认证](https://docs.apiseven.com/api7-gateway/security-and-compliance/authenticate/client-mtls.md): 在 API7 网关上配置双向 TLS（mTLS），在允许访问 API 前使用 X.509 证书认证 API 客户端。 - [控制面与数据面之间的双向 TLS](https://docs.apiseven.com/api7-gateway/security-and-compliance/authenticate/mutual-tls-cp-dp.md): 了解 API7 网关如何使用基于 PKI 的可靠双向 TLS（mTLS）模型，保护控制面与数据面之间的所有通信。 - [为控制台配置 SCIM 预配](https://docs.apiseven.com/api7-gateway/security-and-compliance/authenticate/scim.md): 使用受支持的身份提供商，为 API7 控制台配置 SCIM 用户预配。 - [使用 Microsoft Entra ID 进行 SCIM 预配](https://docs.apiseven.com/api7-gateway/security-and-compliance/authenticate/scim-microsoft-entra-id.md): 为 API7 控制台配置 Microsoft Entra ID SCIM 预配。 - [使用 Okta 进行 SCIM 预配](https://docs.apiseven.com/api7-gateway/security-and-compliance/authenticate/scim-okta.md): 为 API7 控制台配置 Okta SCIM 预配。 - [上游 mTLS](https://docs.apiseven.com/api7-gateway/security-and-compliance/authenticate/upstream-mtls.md): 配置 API7 网关与上游服务之间的双向 TLS（mTLS），使网关向上游出示客户端证书，并可选验证上游的服务器证书。 #### ip-restrictions-control-plane 使用控制面内置 IP 允许列表限制可访问 API7 控制面（控制台和 Admin API）的客户端 IP 地址，并结合网络级控制实现纵深防御。 - [控制面 IP 限制](https://docs.apiseven.com/api7-gateway/security-and-compliance/ip-restrictions-control-plane.md): 使用控制面内置 IP 允许列表限制可访问 API7 控制面（控制台和 Admin API）的客户端 IP 地址，并结合网络级控制实现纵深防御。 #### oauth-oidc 使用现代化的令牌身份认证保护 API，并了解如何将 API7 网关与 Okta、Keycloak 等 OAuth 2.0 和 OpenID Connect（OIDC）提供商集成。 - [OAuth 2.0 和 OIDC](https://docs.apiseven.com/api7-gateway/security-and-compliance/oauth-oidc.md): 使用现代化的令牌身份认证保护 API，并了解如何将 API7 网关与 Okta、Keycloak 等 OAuth 2.0 和 OpenID Connect（OIDC）提供商集成。 #### open-source-licenses 了解 API7 网关对开源软件和许可证合规的承诺，以及所使用的主要开源组件及其许可证。 - [开源许可证](https://docs.apiseven.com/api7-gateway/security-and-compliance/open-source-licenses.md): 了解 API7 网关对开源软件和许可证合规的承诺，以及所使用的主要开源组件及其许可证。 #### overview 了解 API7 网关如何通过身份认证、授权、加密和审计等完整的安全与合规能力保护 API。 - [安全与合规概览](https://docs.apiseven.com/api7-gateway/security-and-compliance/overview.md): 了解 API7 网关如何通过身份认证、授权、加密和审计等完整的安全与合规能力保护 API。 #### permission-policies-and-boundaries 使用原生 JSON 文档格式在 API7 网关中编写权限策略。了解 `statement` 结构、允许的操作、ARN 风格资源、基于标签的条件，以及权限边界如何限制用户的最大权限范围。 - [权限策略和权限边界](https://docs.apiseven.com/api7-gateway/security-and-compliance/permission-policies-and-boundaries.md): 使用原生 JSON 文档格式在 API7 网关中编写权限策略。了解 `statement` 结构、允许的操作、ARN 风格资源、基于标签的条件，以及权限边界如何限制用户的最大权限范围。 #### role-based-access-control 使用基于角色的访问控制管理用户对 API7 网关控制面的访问。为用户分配角色、挂载权限策略，并在网关组之间实施最小权限访问。 - [基于角色的访问控制（RBAC）](https://docs.apiseven.com/api7-gateway/security-and-compliance/role-based-access-control.md): 使用基于角色的访问控制管理用户对 API7 网关控制面的访问。为用户分配角色、挂载权限策略，并在网关组之间实施最小权限访问。 #### secure-credentials 使用 API7 网关安全凭证管理保护敏感信息。了解如何管理 SSL 证书，以及如何与 HashiCorp Vault 等外部密钥管理器集成。 - [安全凭证管理](https://docs.apiseven.com/api7-gateway/security-and-compliance/secure-credentials.md): 使用 API7 网关安全凭证管理保护敏感信息。了解如何管理 SSL 证书，以及如何与 HashiCorp Vault 等外部密钥管理器集成。 #### sso-dashboard 使用单点登录（SSO）集中管理 API7 控制台用户访问。支持 OIDC、SAML、LDAP 和 CAS 协议，并可自动映射角色。 - [控制台单点登录（SSO）](https://docs.apiseven.com/api7-gateway/security-and-compliance/sso-dashboard.md): 使用单点登录（SSO）集中管理 API7 控制台用户访问。支持 OIDC、SAML、LDAP 和 CAS 协议，并可自动映射角色。 #### sso-ldap 使用 LDAP 为 API7 控制台配置单点登录（SSO），使用户能够使用现有目录服务凭证认证。 - [使用 LDAP 实现单点登录](https://docs.apiseven.com/api7-gateway/security-and-compliance/sso-ldap.md): 使用 LDAP 为 API7 控制台配置单点登录（SSO），使用户能够使用现有目录服务凭证认证。 #### sso-oidc 使用 OpenID Connect（OIDC）为 API7 控制台配置单点登录（SSO），并提供 Keycloak、Microsoft Entra ID 和 Auth0 的提供商专用配置指引。 - [使用 OIDC 配置 SSO](https://docs.apiseven.com/api7-gateway/security-and-compliance/sso-oidc.md): 使用 OpenID Connect（OIDC）为 API7 控制台配置单点登录（SSO），并提供 Keycloak、Microsoft Entra ID 和 Auth0 的提供商专用配置指引。 #### sso-saml 使用 SAML 2.0 为 API7 控制台配置单点登录（SSO），并提供 Microsoft Entra ID 和 Okta 的提供商专用配置指引。 - [使用 SAML 配置 SSO](https://docs.apiseven.com/api7-gateway/security-and-compliance/sso-saml.md): 使用 SAML 2.0 为 API7 控制台配置单点登录（SSO），并提供 Microsoft Entra ID 和 Okta 的提供商专用配置指引。 #### trust-center API7 信任中心集中提供所有安全与合规信息，包括认证、安全报告和最佳实践指南。 - [信任中心](https://docs.apiseven.com/api7-gateway/security-and-compliance/trust-center.md): API7 信任中心集中提供所有安全与合规信息，包括认证、安全报告和最佳实践指南。 #### verify-image-signatures 使用 Cosign 和基于 OIDC 的无密钥验证来验证 API7 企业版容器镜像签名，确认每个镜像均由 API7.ai 构建和签名，以保护软件供应链。 - [验证镜像签名](https://docs.apiseven.com/api7-gateway/security-and-compliance/verify-image-signatures.md): 使用 Cosign 和基于 OIDC 的无密钥验证来验证 API7 企业版容器镜像签名，确认每个镜像均由 API7.ai 构建和签名，以保护软件供应链。 #### vulnerability-scanning 了解 API7.ai 针对 API7 网关实施的安全测试和漏洞扫描实践，包括 CVE 报告和补丁流程。 - [漏洞扫描](https://docs.apiseven.com/api7-gateway/security-and-compliance/vulnerability-scanning.md): 了解 API7.ai 针对 API7 网关实施的安全测试和漏洞扫描实践，包括 CVE 报告和补丁流程。 #### web-application-firewall 了解何时将 Web 应用防火墙与 API7 网关结合使用、WAF 在安全模型中的作用，以及当前文档提供的集成方式。 - [Web 应用防火墙（WAF）](https://docs.apiseven.com/api7-gateway/security-and-compliance/web-application-firewall.md): 了解何时将 Web 应用防火墙与 API7 网关结合使用、WAF 在安全模型中的作用，以及当前文档提供的集成方式。 ### tools #### cli-tools - [CLI 工具](https://docs.apiseven.com/api7-gateway/tools/cli-tools.md) #### declarative-api - [声明式 API](https://docs.apiseven.com/api7-gateway/tools/declarative-api.md) ### troubleshooting 诊断并解决 API7 网关部署中的常见问题，包括连接问题、配置错误和性能下降。 - [API7 网关故障排查](https://docs.apiseven.com/api7-gateway/troubleshooting.md): 诊断并解决 API7 网关部署中的常见问题，包括连接问题、配置错误和性能下降。 ### upgrade-guides #### backup-and-restore 了解如何备份和恢复 API7 网关数据，包含数据库备份、声明式配置备份和数据恢复过程的逐步说明。 - [备份与恢复](https://docs.apiseven.com/api7-gateway/upgrade-guides/backup-and-restore.md): 了解如何备份和恢复 API7 网关数据，包含数据库备份、声明式配置备份和数据恢复过程的逐步说明。 #### breaking-changes 了解 API7 企业版各个版本中的重大变更，包括已废弃的功能和升级注意事项，以避免服务中断。 - [历史重大变更](https://docs.apiseven.com/api7-gateway/upgrade-guides/breaking-changes.md): 了解 API7 企业版各个版本中的重大变更，包括已废弃的功能和升级注意事项，以避免服务中断。 #### cluster-migration 一份详细的分步指南，帮助你在零停机的情况下将 API7 网关部署迁移至新集群。 - [API 网关集群迁移](https://docs.apiseven.com/api7-gateway/upgrade-guides/cluster-migration.md): 一份详细的分步指南，帮助你在零停机的情况下将 API7 网关部署迁移至新集群。 #### dual-cluster 逐步执行 API7 网关双集群升级的指南，涵盖新集群部署、流量切换和回滚过程。 - [双集群升级](https://docs.apiseven.com/api7-gateway/upgrade-guides/dual-cluster.md): 逐步执行 API7 网关双集群升级的指南，涵盖新集群部署、流量切换和回滚过程。 #### in-place 逐步执行 API7 网关控制面就地升级的指南，涵盖数据库重用、配置更新和验证过程。 - [就地升级](https://docs.apiseven.com/api7-gateway/upgrade-guides/in-place.md): 逐步执行 API7 网关控制面就地升级的指南，涵盖数据库重用、配置更新和验证过程。 #### rolling-upgrade 逐步执行 API7 网关数据面节点滚动升级的指南，在维持 API 请求处理和服务连续性的同时确保零停机时间。 - [滚动升级](https://docs.apiseven.com/api7-gateway/upgrade-guides/rolling-upgrade.md): 逐步执行 API7 网关数据面节点滚动升级的指南，在维持 API 请求处理和服务连续性的同时确保零停机时间。 #### upgrade API7 网关升级的综合指南，涵盖控制面就地升级、数据面滚动升级、数据备份及稳定性注意事项。 - [升级 API7 网关](https://docs.apiseven.com/api7-gateway/upgrade-guides/upgrade.md): API7 网关升级的综合指南，涵盖控制面就地升级、数据面滚动升级、数据备份及稳定性注意事项。 ### version-support-policy API7 企业版版本支持生命周期、LTS 策略和升级指南。了解各版本的支持时长以及当前指定为 LTS 的版本。 - [版本支持策略](https://docs.apiseven.com/api7-gateway/version-support-policy.md): API7 企业版版本支持生命周期、LTS 策略和升级指南。了解各版本的支持时长以及当前指定为 LTS 的版本。 ## apisix ### ai-agent-skills 使用 Claude Code、Cursor 等 AI 编程代理，以自然语言配置和运维 Apache APISIX API 网关。 - [Apache APISIX AI Agent Skills](https://docs.apiseven.com/apisix/ai-agent-skills.md): 使用 Claude Code、Cursor 等 AI 编程代理，以自然语言配置和运维 Apache APISIX API 网关。 #### a6-persona-developer 面向使用 a6 CLI 在 Apache APISIX 中构建和测试 API 的开发者角色 Skill，提供 API 设计、路由配置、插件选择、测试、本地开发和 CI/CD 集成的决策框架。 - [a6-persona-developer](https://docs.apiseven.com/apisix/ai-agent-skills/a6-persona-developer.md): 面向使用 a6 CLI 在 Apache APISIX 中构建和测试 API 的开发者角色 Skill，提供 API 设计、路由配置、插件选择、测试、本地开发和 CI/CD 集成的决策框架。 #### a6-persona-operator 面向使用 a6 CLI 管理 Apache APISIX 实例的平台运维人员和 DevOps 工程师角色 Skill，涵盖部署、监控、故障排查、扩缩容、安全加固和灾难恢复等日常运维决策。 - [a6-persona-operator](https://docs.apiseven.com/apisix/ai-agent-skills/a6-persona-operator.md): 面向使用 a6 CLI 管理 Apache APISIX 实例的平台运维人员和 DevOps 工程师角色 Skill，涵盖部署、监控、故障排查、扩缩容、安全加固和灾难恢复等日常运维决策。 #### a6-plugin-ai-content-moderation 用于通过 a6 CLI 配置 Apache APISIX AI 内容审核插件的 Skill，涵盖 ai-aws-content-moderation（AWS Comprehend，仅请求）和 ai-aliyun-content-moderation（阿里云，请求与响应并支持流式传输）、毒性阈值、类别过滤以及与 ai-proxy 的集成。 - [a6-plugin-ai-content-moderation](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-ai-content-moderation.md): 用于通过 a6 CLI 配置 Apache APISIX AI 内容审核插件的 Skill，涵盖 ai-aws-content-moderation（AWS Comprehend，仅请求）和 ai-aliyun-content-moderation（阿里云，请求与响应并支持流式传输）、毒性阈值、类别过滤以及与 ai-proxy 的集成。 #### a6-plugin-ai-prompt-decorator 用于通过 a6 CLI 配置 Apache APISIX ai-prompt-decorator 插件的 Skill，涵盖向 LLM 请求添加系统、用户和助手消息前缀或后缀、设置对话上下文以及强制执行安全指南。 - [a6-plugin-ai-prompt-decorator](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-ai-prompt-decorator.md): 用于通过 a6 CLI 配置 Apache APISIX ai-prompt-decorator 插件的 Skill，涵盖向 LLM 请求添加系统、用户和助手消息前缀或后缀、设置对话上下文以及强制执行安全指南。 #### a6-plugin-ai-prompt-template 用于通过 a6 CLI 配置 Apache APISIX ai-prompt-template 插件的 Skill，涵盖定义带变量占位符的可复用提示词模板、强制执行提示词结构，以及与 ai-proxy 组合构建完整的 AI 网关流水线。 - [a6-plugin-ai-prompt-template](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-ai-prompt-template.md): 用于通过 a6 CLI 配置 Apache APISIX ai-prompt-template 插件的 Skill，涵盖定义带变量占位符的可复用提示词模板、强制执行提示词结构，以及与 ai-proxy 组合构建完整的 AI 网关流水线。 #### a6-plugin-ai-proxy 用于通过 a6 CLI 配置 Apache APISIX ai-proxy 插件的 Skill，涵盖 Chat Completions、Responses 和 Embeddings 的身份认证与代理。 - [a6-plugin-ai-proxy](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-ai-proxy.md): 用于通过 a6 CLI 配置 Apache APISIX ai-proxy 插件的 Skill，涵盖 Chat Completions、Responses 和 Embeddings 的身份认证与代理。 #### a6-plugin-basic-auth 用于通过 a6 CLI 配置 Apache APISIX basic-auth 插件的 Skill，涵盖路由上的 HTTP Basic Authentication、带用户名和密码的消费者凭证关联、hide_credentials、匿名消费者回退以及常见运维模式。 - [a6-plugin-basic-auth](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-basic-auth.md): 用于通过 a6 CLI 配置 Apache APISIX basic-auth 插件的 Skill，涵盖路由上的 HTTP Basic Authentication、带用户名和密码的消费者凭证关联、hide_credentials、匿名消费者回退以及常见运维模式。 #### a6-plugin-consumer-restriction 用于通过 a6 CLI 配置 Apache APISIX consumer-restriction 插件的 Skill，涵盖按消费者名称、服务 ID 或路由 ID 进行访问限制，白名单/黑名单模式以及按消费者限制 HTTP 方法。 - [a6-plugin-consumer-restriction](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-consumer-restriction.md): 用于通过 a6 CLI 配置 Apache APISIX consumer-restriction 插件的 Skill，涵盖按消费者名称、服务 ID 或路由 ID 进行访问限制，白名单/黑名单模式以及按消费者限制 HTTP 方法。 #### a6-plugin-cors 用于通过 a6 CLI 配置 Apache APISIX cors 插件的 Skill，涵盖路由上的跨域资源共享、allow_origins、allow_methods、allow_headers、凭证处理、正则来源匹配、预检缓存以及常见运维模式。 - [a6-plugin-cors](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-cors.md): 用于通过 a6 CLI 配置 Apache APISIX cors 插件的 Skill，涵盖路由上的跨域资源共享、allow_origins、allow_methods、allow_headers、凭证处理、正则来源匹配、预检缓存以及常见运维模式。 #### a6-plugin-datadog 用于通过 a6 CLI 配置 Apache APISIX datadog 插件的 Skill，涵盖通过 DogStatsD 向 Datadog 推送自定义指标、指标标签、批处理、全局 DogStatsD 服务器配置的插件元数据以及 Datadog Agent 集成。 - [a6-plugin-datadog](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-datadog.md): 用于通过 a6 CLI 配置 Apache APISIX datadog 插件的 Skill，涵盖通过 DogStatsD 向 Datadog 推送自定义指标、指标标签、批处理、全局 DogStatsD 服务器配置的插件元数据以及 Datadog Agent 集成。 #### a6-plugin-ext-plugin 用于通过 a6 CLI 配置 Apache APISIX外部插件系统（ext-plugin-pre-req、ext-plugin-post-req、ext-plugin-post-resp）的 Skill，涵盖 Plugin Runner 架构、Go/Java/Python Runner 配置、RPC 协议、优雅降级以及性能注意事项。 - [a6-plugin-ext-plugin](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-ext-plugin.md): 用于通过 a6 CLI 配置 Apache APISIX外部插件系统（ext-plugin-pre-req、ext-plugin-post-req、ext-plugin-post-resp）的 Skill，涵盖 Plugin Runner 架构、Go/Java/Python Runner 配置、RPC 协议、优雅降级以及性能注意事项。 #### a6-plugin-fault-injection 使用 a6 CLI 配置 Apache APISIX fault-injection 插件的 Skill，涵盖为混沌工程注入延迟和 HTTP 中止、按百分比采样、通过 vars 表达式条件注入，以及自定义响应头和响应体。 - [a6-plugin-fault-injection](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-fault-injection.md): 使用 a6 CLI 配置 Apache APISIX fault-injection 插件的 Skill，涵盖为混沌工程注入延迟和 HTTP 中止、按百分比采样、通过 vars 表达式条件注入，以及自定义响应头和响应体。 #### a6-plugin-grpc-transcode 用于通过 a6 CLI 配置 Apache APISIX grpc-transcode 插件的 Skill，涵盖将 RESTful HTTP 请求转换为 gRPC、proto 文件管理、用于数据类型转换的 pb_option 设置、错误详情解码以及常见运维模式。 - [a6-plugin-grpc-transcode](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-grpc-transcode.md): 用于通过 a6 CLI 配置 Apache APISIX grpc-transcode 插件的 Skill，涵盖将 RESTful HTTP 请求转换为 gRPC、proto 文件管理、用于数据类型转换的 pb_option 设置、错误详情解码以及常见运维模式。 #### a6-plugin-hmac-auth 用于通过 a6 CLI 配置 Apache APISIX hmac-auth 插件的 Skill，涵盖 HMAC 签名认证、带 key_id/secret_key 的消费者凭证关联、允许的算法、时钟偏差处理、请求体校验、签名请求头以及常见运维模式。 - [a6-plugin-hmac-auth](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-hmac-auth.md): 用于通过 a6 CLI 配置 Apache APISIX hmac-auth 插件的 Skill，涵盖 HMAC 签名认证、带 key_id/secret_key 的消费者凭证关联、允许的算法、时钟偏差处理、请求体校验、签名请求头以及常见运维模式。 #### a6-plugin-http-logger 用于通过 a6 CLI 配置 Apache APISIX http-logger 插件的 Skill，涵盖批量推送访问日志、自定义 NGINX 变量日志格式、按条件记录请求/响应体、批处理调优和外部日志系统集成。 - [a6-plugin-http-logger](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-http-logger.md): 用于通过 a6 CLI 配置 Apache APISIX http-logger 插件的 Skill，涵盖批量推送访问日志、自定义 NGINX 变量日志格式、按条件记录请求/响应体、批处理调优和外部日志系统集成。 #### a6-plugin-ip-restriction 用于通过 a6 CLI 配置 Apache APISIX ip-restriction 插件的 Skill，涵盖路由上的 IP 白名单/黑名单、CIDR 范围、IPv4/IPv6、代理后提取真实客户端 IP、自定义错误消息以及常见运维模式。 - [a6-plugin-ip-restriction](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-ip-restriction.md): 用于通过 a6 CLI 配置 Apache APISIX ip-restriction 插件的 Skill，涵盖路由上的 IP 白名单/黑名单、CIDR 范围、IPv4/IPv6、代理后提取真实客户端 IP、自定义错误消息以及常见运维模式。 #### a6-plugin-jwt-auth 用于通过 a6 CLI 配置 Apache APISIX jwt-auth 插件的 Skill，涵盖 JWT Token 认证、HS256/RS256 算法选择、消费者凭证关联、从请求头/查询参数/Cookie 查找 Token、声明处理、时钟偏差、密钥管理以及常见运维模式。 - [a6-plugin-jwt-auth](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-jwt-auth.md): 用于通过 a6 CLI 配置 Apache APISIX jwt-auth 插件的 Skill，涵盖 JWT Token 认证、HS256/RS256 算法选择、消费者凭证关联、从请求头/查询参数/Cookie 查找 Token、声明处理、时钟偏差、密钥管理以及常见运维模式。 #### a6-plugin-kafka-logger 用于通过 a6 CLI 配置 Apache APISIX kafka-logger 插件的 Skill，涵盖 Kafka 主题、Broker、SASL PLAIN/SCRAM 身份认证、自定义日志格式、Producer 调优和批处理。 - [a6-plugin-kafka-logger](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-kafka-logger.md): 用于通过 a6 CLI 配置 Apache APISIX kafka-logger 插件的 Skill，涵盖 Kafka 主题、Broker、SASL PLAIN/SCRAM 身份认证、自定义日志格式、Producer 调优和批处理。 #### a6-plugin-key-auth 用于通过 a6 CLI 配置 Apache APISIX key-auth 插件的 Skill，涵盖路由上的 API Key 认证、消费者凭证关联、从请求头/查询参数/Cookie 查找 Key、hide_credentials、匿名消费者回退以及常见运维模式。 - [a6-plugin-key-auth](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-key-auth.md): 用于通过 a6 CLI 配置 Apache APISIX key-auth 插件的 Skill，涵盖路由上的 API Key 认证、消费者凭证关联、从请求头/查询参数/Cookie 查找 Key、hide_credentials、匿名消费者回退以及常见运维模式。 #### a6-plugin-limit-count 用于通过 a6 CLI 配置 Apache APISIX limit-count 插件的 Skill，涵盖固定窗口限流、count/time_window 配置、Key 类型、用于分布式限流的 Redis 和 Redis 集群策略、基于组的共享配额、消费者级与路由级限流、响应头以及常见运维模式。 - [a6-plugin-limit-count](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-limit-count.md): 用于通过 a6 CLI 配置 Apache APISIX limit-count 插件的 Skill，涵盖固定窗口限流、count/time_window 配置、Key 类型、用于分布式限流的 Redis 和 Redis 集群策略、基于组的共享配额、消费者级与路由级限流、响应头以及常见运维模式。 #### a6-plugin-limit-req 用于通过 a6 CLI 配置 Apache APISIX limit-req 插件的 Skill，涵盖漏桶限流、rate/burst 配置、nodelay 行为、Key 类型、用于分布式限流的 Redis 策略、流量平滑以及与 limit-count 组合使用等常见运维模式。 - [a6-plugin-limit-req](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-limit-req.md): 用于通过 a6 CLI 配置 Apache APISIX limit-req 插件的 Skill，涵盖漏桶限流、rate/burst 配置、nodelay 行为、Key 类型、用于分布式限流的 Redis 策略、流量平滑以及与 limit-count 组合使用等常见运维模式。 #### a6-plugin-openid-connect 用于通过 a6 CLI 配置 Apache APISIX openid-connect 插件的 Skill，涵盖 OIDC 授权码流程、Bearer Token 校验、Token 内省（Token introspection）与 JWKS 校验、会话管理、Keycloak/Auth0/Okta 提供方配置、重定向 URI 以及常见运维模式。 - [a6-plugin-openid-connect](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-openid-connect.md): 用于通过 a6 CLI 配置 Apache APISIX openid-connect 插件的 Skill，涵盖 OIDC 授权码流程、Bearer Token 校验、Token 内省（Token introspection）与 JWKS 校验、会话管理、Keycloak/Auth0/Okta 提供方配置、重定向 URI 以及常见运维模式。 #### a6-plugin-prometheus 用于通过 a6 CLI 配置 Apache APISIX prometheus 插件的 Skill，涵盖路由级和全局指标、HTTP 状态、延迟、带宽、上游健康和 LLM Token 指标，以及自定义标签、直方图桶和 Grafana 集成。 - [a6-plugin-prometheus](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-prometheus.md): 用于通过 a6 CLI 配置 Apache APISIX prometheus 插件的 Skill，涵盖路由级和全局指标、HTTP 状态、延迟、带宽、上游健康和 LLM Token 指标，以及自定义标签、直方图桶和 Grafana 集成。 #### a6-plugin-proxy-rewrite 用于通过 a6 CLI 配置 Apache APISIX proxy-rewrite 插件的 Skill，涵盖将请求 URI、主机、方法、请求头和协议重写后再转发到上游，包括正则 URI 重写、请求头操作以及常见运维模式。 - [a6-plugin-proxy-rewrite](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-proxy-rewrite.md): 用于通过 a6 CLI 配置 Apache APISIX proxy-rewrite 插件的 Skill，涵盖将请求 URI、主机、方法、请求头和协议重写后再转发到上游，包括正则 URI 重写、请求头操作以及常见运维模式。 #### a6-plugin-redirect 用于通过 a6 CLI 配置 Apache APISIX redirect 插件的 Skill，涵盖 URI 重定向、HTTP 到 HTTPS 重定向、基于正则的 URI 重写、查询字符串处理以及常见运维模式。 - [a6-plugin-redirect](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-redirect.md): 用于通过 a6 CLI 配置 Apache APISIX redirect 插件的 Skill，涵盖 URI 重定向、HTTP 到 HTTPS 重定向、基于正则的 URI 重写、查询字符串处理以及常见运维模式。 #### a6-plugin-response-rewrite 用于通过 a6 CLI 配置 Apache APISIX response-rewrite 插件的 Skill，涵盖向客户端返回前重写响应状态码、请求头和响应体，包括使用 vars 条件执行、正则响应体过滤器以及常见运维模式。 - [a6-plugin-response-rewrite](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-response-rewrite.md): 用于通过 a6 CLI 配置 Apache APISIX response-rewrite 插件的 Skill，涵盖向客户端返回前重写响应状态码、请求头和响应体，包括使用 vars 条件执行、正则响应体过滤器以及常见运维模式。 #### a6-plugin-serverless 用于通过 a6 CLI 配置 Apache APISIX serverless-pre-function 和 serverless-post-function 插件的 Skill，涵盖在可配置请求阶段执行内联 Lua 函数、函数签名、闭包模式、可用 Lua API 以及执行顺序。 - [a6-plugin-serverless](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-serverless.md): 用于通过 a6 CLI 配置 Apache APISIX serverless-pre-function 和 serverless-post-function 插件的 Skill，涵盖在可配置请求阶段执行内联 Lua 函数、函数签名、闭包模式、可用 Lua API 以及执行顺序。 #### a6-plugin-skywalking 用于通过 a6 CLI 配置 Apache APISIX skywalking 插件的 Skill，涵盖使用 Apache SkyWalking OAP 进行分布式追踪、采样配置、服务拓扑以及常见运维模式。 - [a6-plugin-skywalking](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-skywalking.md): 用于通过 a6 CLI 配置 Apache APISIX skywalking 插件的 Skill，涵盖使用 Apache SkyWalking OAP 进行分布式追踪、采样配置、服务拓扑以及常见运维模式。 #### a6-plugin-traffic-split 用于通过 a6 CLI 配置 Apache APISIX traffic-split 插件的 Skill，涵盖通过条件匹配规则在上游之间进行加权流量拆分，包括灰度发布、蓝绿发布、A/B 测试模式以及常见运维模式。 - [a6-plugin-traffic-split](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-traffic-split.md): 用于通过 a6 CLI 配置 Apache APISIX traffic-split 插件的 Skill，涵盖通过条件匹配规则在上游之间进行加权流量拆分，包括灰度发布、蓝绿发布、A/B 测试模式以及常见运维模式。 #### a6-plugin-wolf-rbac 用于通过 a6 CLI 配置 Apache APISIX wolf-rbac 插件的 Skill，涵盖与 Wolf RBAC 服务器集成以实现基于角色的访问控制、Token 管理、登录/用户信息/修改密码 API 端点、权限检查流程以及多应用配置。 - [a6-plugin-wolf-rbac](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-wolf-rbac.md): 用于通过 a6 CLI 配置 Apache APISIX wolf-rbac 插件的 Skill，涵盖与 Wolf RBAC 服务器集成以实现基于角色的访问控制、Token 管理、登录/用户信息/修改密码 API 端点、权限检查流程以及多应用配置。 #### a6-plugin-zipkin 用于通过 a6 CLI 配置 Apache APISIX zipkin 插件的 Skill，涵盖使用 Zipkin、Jaeger 或任何兼容 Zipkin 的收集器进行分布式追踪、B3 传播请求头、采样以及常见运维模式。 - [a6-plugin-zipkin](https://docs.apiseven.com/apisix/ai-agent-skills/a6-plugin-zipkin.md): 用于通过 a6 CLI 配置 Apache APISIX zipkin 插件的 Skill，涵盖使用 Zipkin、Jaeger 或任何兼容 Zipkin 的收集器进行分布式追踪、B3 传播请求头、采样以及常见运维模式。 #### a6-recipe-api-versioning 使用 a6 CLI 实现 API 版本管理策略的方案 Skill，涵盖 URI 路径、请求头和查询参数版本管理，以及通过 traffic-split 和 redirect 完成渐进式迁移与版本弃用。 - [a6-recipe-api-versioning](https://docs.apiseven.com/apisix/ai-agent-skills/a6-recipe-api-versioning.md): 使用 a6 CLI 实现 API 版本管理策略的方案 Skill，涵盖 URI 路径、请求头和查询参数版本管理，以及通过 traffic-split 和 redirect 完成渐进式迁移与版本弃用。 #### a6-recipe-blue-green 使用 a6 CLI 实现蓝绿发布的方案 Skill，涵盖创建两套上游环境、通过路由更新或 traffic-split 即时切换流量、回滚，以及声明式配置同步。 - [a6-recipe-blue-green](https://docs.apiseven.com/apisix/ai-agent-skills/a6-recipe-blue-green.md): 使用 a6 CLI 实现蓝绿发布的方案 Skill，涵盖创建两套上游环境、通过路由更新或 traffic-split 即时切换流量、回滚，以及声明式配置同步。 #### a6-recipe-canary 使用 a6 CLI 在 Apache APISIX 中实现灰度发布的方案 Skill，涵盖通过 traffic-split 插件渐进式转移流量、基于请求头的灰度路由、监控检查点以及完整的发布或回滚工作流。 - [a6-recipe-canary](https://docs.apiseven.com/apisix/ai-agent-skills/a6-recipe-canary.md): 使用 a6 CLI 在 Apache APISIX 中实现灰度发布的方案 Skill，涵盖通过 traffic-split 插件渐进式转移流量、基于请求头的灰度路由、监控检查点以及完整的发布或回滚工作流。 #### a6-recipe-circuit-breaker 使用 a6 CLI 在 Apache APISIX 中实现服务熔断模式的方案 Skill，涵盖 api-breaker 插件、不健康阈值、健康恢复、响应码分类以及与服务健康检查的集成。 - [a6-recipe-circuit-breaker](https://docs.apiseven.com/apisix/ai-agent-skills/a6-recipe-circuit-breaker.md): 使用 a6 CLI 在 Apache APISIX 中实现服务熔断模式的方案 Skill，涵盖 api-breaker 插件、不健康阈值、健康恢复、响应码分类以及与服务健康检查的集成。 #### a6-recipe-graphql-proxy 使用 a6 CLI 实现 GraphQL 代理模式的方案 Skill，涵盖基于内置 GraphQL 变量的操作级路由和限流、使用 degraphql 将 REST 转换为 GraphQL，以及 GraphQL API 安全。 - [a6-recipe-graphql-proxy](https://docs.apiseven.com/apisix/ai-agent-skills/a6-recipe-graphql-proxy.md): 使用 a6 CLI 实现 GraphQL 代理模式的方案 Skill，涵盖基于内置 GraphQL 变量的操作级路由和限流、使用 degraphql 将 REST 转换为 GraphQL，以及 GraphQL API 安全。 #### a6-recipe-health-check 使用 a6 CLI 配置上游健康检查的方案 Skill，涵盖主动 HTTP 探测、被动响应分析、组合使用两种检查、健康/不健康阈值，以及上游节点状态监控。 - [a6-recipe-health-check](https://docs.apiseven.com/apisix/ai-agent-skills/a6-recipe-health-check.md): 使用 a6 CLI 配置上游健康检查的方案 Skill，涵盖主动 HTTP 探测、被动响应分析、组合使用两种检查、健康/不健康阈值，以及上游节点状态监控。 #### a6-recipe-mtls 使用 a6 CLI 配置双向 TLS（mTLS）的方案 Skill，涵盖 SSL 证书管理、连接后端服务的上游 mTLS、客户端证书校验，以及从客户端经 Apache APISIX 到上游的端到端 mTLS。 - [a6-recipe-mtls](https://docs.apiseven.com/apisix/ai-agent-skills/a6-recipe-mtls.md): 使用 a6 CLI 配置双向 TLS（mTLS）的方案 Skill，涵盖 SSL 证书管理、连接后端服务的上游 mTLS、客户端证书校验，以及从客户端经 Apache APISIX 到上游的端到端 mTLS。 #### a6-recipe-multi-tenant 使用 a6 CLI 实现多租户 API 网关模式的方案 Skill，涵盖通过消费者组实现租户隔离、基于 Host/路径/请求头的路由、租户级限流、上下文转发和声明式配置同步。 - [a6-recipe-multi-tenant](https://docs.apiseven.com/apisix/ai-agent-skills/a6-recipe-multi-tenant.md): 使用 a6 CLI 实现多租户 API 网关模式的方案 Skill，涵盖通过消费者组实现租户隔离、基于 Host/路径/请求头的路由、租户级限流、上下文转发和声明式配置同步。 #### a6-shared 使用 Apache APISIX命令行工具 a6 的核心 Skill，提供项目约定、命令模式、双 API 架构和开发工作流；在处理 a6 源代码、添加新命令、编写测试或修改任何 a6 组件时加载此 Skill。 - [a6-shared](https://docs.apiseven.com/apisix/ai-agent-skills/a6-shared.md): 使用 Apache APISIX命令行工具 a6 的核心 Skill，提供项目约定、命令模式、双 API 架构和开发工作流；在处理 a6 源代码、添加新命令、编写测试或修改任何 a6 组件时加载此 Skill。 ### documentation 探索全面的 Apache APISIX 文档，涵盖安装、指南、插件以及高效 API 管理和网关功能的关键概念。 - [Apache APISIX 文档](https://docs.apiseven.com/apisix/documentation.md): 探索全面的 Apache APISIX 文档，涵盖安装、指南、插件以及高效 API 管理和网关功能的关键概念。 ### getting-started 了解如何快速安装和配置 Apache APISIX，这是一个动态且高性能的 API 网关，用于简化你的 API 生命周期管理。 - [安装 APISIX](https://docs.apiseven.com/apisix/getting-started.md): 了解如何快速安装和配置 Apache APISIX，这是一个动态且高性能的 API 网关，用于简化你的 API 生命周期管理。 #### configure-routes 了解如何在 Apache APISIX 中定义路由以管理流量、匹配客户端请求并有效地将其转发到上游服务。 - [配置路由](https://docs.apiseven.com/apisix/getting-started/configure-routes.md): 了解如何在 Apache APISIX 中定义路由以管理流量、匹配客户端请求并有效地将其转发到上游服务。 #### key-authentication 探索如何在 Apache APISIX 中配置密钥认证，通过有效管理消费者凭证来允许对你的 API 进行安全访问。 - [密钥认证](https://docs.apiseven.com/apisix/getting-started/key-authentication.md): 探索如何在 Apache APISIX 中配置密钥认证，通过有效管理消费者凭证来允许对你的 API 进行安全访问。 #### load-balancing 了解如何在 Apache APISIX 中实现负载均衡，利用各种算法在多个上游服务之间分配传入请求。 - [负载均衡](https://docs.apiseven.com/apisix/getting-started/load-balancing.md): 了解如何在 Apache APISIX 中实现负载均衡，利用各种算法在多个上游服务之间分配传入请求。 #### management-options 比较 Admin API、ADC、a6 CLI 和 APISIX-MCP，为交互式操作或自动化选择合适的 APISIX 资源管理工作流。 - [管理方式](https://docs.apiseven.com/apisix/getting-started/management-options.md): 比较 Admin API、ADC、a6 CLI 和 APISIX-MCP，为交互式操作或自动化选择合适的 APISIX 资源管理工作流。 #### rate-limiting 在 Apache APISIX 中实施限流限速，以控制流量，保护你的 API 免受滥用，并通过设置请求限制确保公平使用。 - [限流限速](https://docs.apiseven.com/apisix/getting-started/rate-limiting.md): 在 Apache APISIX 中实施限流限速，以控制流量，保护你的 API 免受滥用，并通过设置请求限制确保公平使用。 ### how-apisix-works 了解 Apache APISIX 如何从配置存储到上游选择端到端处理请求，以及路由和热更新设计如何支持数千条路由而无需重启。 - [APISIX 工作原理](https://docs.apiseven.com/apisix/how-apisix-works.md): 了解 Apache APISIX 如何从配置存储到上游选择端到端处理请求，以及路由和热更新设计如何支持数千条路由而无需重启。 ### how-to-guide #### ai-gateway - [配置提示词装饰器](https://docs.apiseven.com/apisix/how-to-guide/ai-gateway/configure-prompt-decorators.md): 了解如何配置 APISIX 提示词装饰器，在网关为 OpenAI Chat Completions 和 Responses API 请求前置或追加指令。 - [实施提示词防护栏](https://docs.apiseven.com/apisix/how-to-guide/ai-gateway/implement-prompt-guardrails.md): 探索如何在 Apache APISIX 中实施提示词防护栏，以保护用户隐私并在使用大型语言模型 (LLM) 时阻止意外的模型行为。 - [预定义提示词模板](https://docs.apiseven.com/apisix/how-to-guide/ai-gateway/pre-define-prompt-templates.md): 了解如何在 APISIX 中使用客户端提供的值、OpenAI Web 搜索和工具，为 Chat Completions 与 Responses API 配置可复用的提示词模板。 - [代理 Amazon Bedrock 请求](https://docs.apiseven.com/apisix/how-to-guide/ai-gateway/proxy-amazon-bedrock-requests.md): 了解如何配置 APISIX 向 Amazon Bedrock 进行身份认证，并使用 ai-proxy 插件代理 Converse 和 ConverseStream 请求。 - [代理 Anthropic 请求](https://docs.apiseven.com/apisix/how-to-guide/ai-gateway/proxy-anthropic-requests.md): 了解如何使用 ai-proxy 插件在 Apache APISIX 中代理请求到 Anthropic，通过 OpenAI 兼容 API 访问 Claude 模型，而无需指定自定义端点。 - [代理 Azure OpenAI 请求](https://docs.apiseven.com/apisix/how-to-guide/ai-gateway/proxy-azure-openai-requests.md): 了解如何配置 APISIX 通过 Azure OpenAI 进行身份认证，并代理流式和非流式的 Chat Completions 与 Responses API 请求。 - [代理 Gemini 请求](https://docs.apiseven.com/apisix/how-to-guide/ai-gateway/proxy-gemini-requests.md): 了解如何配置 Apache APISIX 以使用 ai-proxy 插件代理对 Google Gemini 的请求，从而无需指定自定义端点即可通过 OpenAI 兼容 API 访问 Gemini 模型。 - [代理 OpenAI 请求](https://docs.apiseven.com/apisix/how-to-guide/ai-gateway/proxy-openai-requests.md): 了解如何配置 APISIX 通过 OpenAI 进行身份认证，并使用 ai-proxy 插件代理 Chat Completions、Responses API 和 Embeddings 请求。 - [代理 OpenRouter 请求](https://docs.apiseven.com/apisix/how-to-guide/ai-gateway/proxy-openrouter-requests.md): 了解如何配置 Apache APISIX 以使用 ai-proxy 插件代理对 OpenRouter 的请求，从而无需指定自定义端点即可通过 OpenAI 兼容 API 访问许多模型服务提供方。 - [代理 Vertex AI 请求](https://docs.apiseven.com/apisix/how-to-guide/ai-gateway/proxy-vertex-ai-requests.md): 了解如何配置 Apache APISIX 以使用 ai-proxy 插件代理对 Google Vertex AI 的请求，从而通过 OpenAI 兼容 API 访问 Gemini 模型。 #### authentication - [实施基本认证](https://docs.apiseven.com/apisix/how-to-guide/authentication/implement-basic-auth.md): 了解如何在 Apache APISIX 中设置基本认证，允许客户端使用用户名和密码组合安全地进行身份认证。 - [实施 HMAC 认证](https://docs.apiseven.com/apisix/how-to-guide/authentication/implement-hmac-auth.md): 探索在 Apache APISIX 中设置 HMAC 认证的过程，通过使用共享密钥的加密签名确确保 API 请求的安全。 - [实施 JWT 认证](https://docs.apiseven.com/apisix/how-to-guide/authentication/implement-jwt-auth.md): 了解如何在 Apache APISIX 中实施 JWT 认证，允许使用 JSON Web Token 对 API 客户端进行安全且无状态的身份认证。 - [实施密钥认证](https://docs.apiseven.com/apisix/how-to-guide/authentication/implement-key-auth.md): 了解如何在 Apache APISIX 中设置密钥认证，允许你向消费者颁发唯一的 API 密钥，以实现对 API 的有效访问控制。 - [保护 WebSocket 流量](https://docs.apiseven.com/apisix/how-to-guide/authentication/secure-websocket-traffic.md): 了解如何在 Apache APISIX 中保护 WebSocket 流量，在初始握手期间实施身份认证机制以保护 WebSocket 连接。 - [设置 Amazon Cognito 单点登录](https://docs.apiseven.com/apisix/how-to-guide/authentication/set-up-sso-with-amazon-cognito.md): 了解如何在 Apache APISIX 中使用 Amazon Cognito 设置单点登录 (SSO)，从而促进安全的用户身份认证和访问管理。 - [设置 Auth0 单点登录](https://docs.apiseven.com/apisix/how-to-guide/authentication/set-up-sso-with-auth0.md): 了解如何配置 Apache APISIX 以使用 Auth0 进行单点登录 (SSO)，通过各种身份管理功能实现安全的用户身份认证。 - [设置 Microsoft Entra ID (Azure AD) 单点登录](https://docs.apiseven.com/apisix/how-to-guide/authentication/set-up-sso-with-azure-ad.md): 了解如何在 Apache APISIX 中使用 Microsoft Entra ID (Azure AD) 设置单点登录 (SSO)，以便通过 OpenID Connect 进行安全身份认证。 - [设置 Google 单点登录](https://docs.apiseven.com/apisix/how-to-guide/authentication/set-up-sso-with-google.md): 探索如何将 Apache APISIX 与 Google 集成以使用 OpenID Connect 进行单点登录 (SSO)，从而为你的 API 提供安全的用户身份认证。 - [设置 Keycloak 单点登录](https://docs.apiseven.com/apisix/how-to-guide/authentication/set-up-sso-with-keycloak.md): 了解如何将 Apache APISIX 与 Keycloak 集成，通过 OpenID Connect 实现安全的单点登录（SSO）身份认证流程。 - [设置 Okta 单点登录](https://docs.apiseven.com/apisix/how-to-guide/authentication/set-up-sso-with-okta.md): 了解如何配置 Apache APISIX 以与 Okta 进行单点登录 (SSO)，从而使用 OpenID Connect 实现安全的身份认证流程。 #### custom-plugins - [使用 Lua 创建自定义插件](https://docs.apiseven.com/apisix/how-to-guide/custom-plugins/create-plugin-in-lua.md): 了解如何为 Apache APISIX 开发自定义 Lua 插件以扩展其功能。 - [在 APISIX 中使用 Wasm 插件](https://docs.apiseven.com/apisix/how-to-guide/custom-plugins/wasm-plugins.md): 了解如何在 Apache APISIX 中实施 WebAssembly (Wasm) 插件，利用 Proxy-Wasm 规范增强功能。 #### observability - [在访问日志中记录消费者标签](https://docs.apiseven.com/apisix/how-to-guide/observability/log-consumer-label-in-access-log.md): 了解如何配置 Apache APISIX 以在访问日志中记录消费者标签，从而增强 API 管理和安全性。 - [使用 ClickHouse 记录日志](https://docs.apiseven.com/apisix/how-to-guide/observability/log-with-clickhouse.md): 了解如何配置 Apache APISIX 将访问信息记录到 ClickHouse，从而促进高效的日志管理和分析。 - [使用 Elasticsearch 记录日志](https://docs.apiseven.com/apisix/how-to-guide/observability/log-with-elasticsearch.md): 了解如何将 Apache APISIX 与 Elasticsearch 集成以收集和索引日志，并通过 ELK 技术栈提供强大的搜索和可视化能力。 - [使用 Datadog 监控 APISIX 指标](https://docs.apiseven.com/apisix/how-to-guide/observability/monitor-apisix-with-datadog.md): 探索将 Datadog 与 Apache APISIX 集成以监控指标的过程，从而增强可观测性和警报能力。 - [使用 Prometheus 监控 APISIX 指标](https://docs.apiseven.com/apisix/how-to-guide/observability/monitor-apisix-with-prometheus.md): 了解如何在 Apache APISIX 中启用 Prometheus 以收集指标，从而有效监控系统性能和健康状况。 - [使用 Zipkin 追踪请求](https://docs.apiseven.com/apisix/how-to-guide/observability/trace-with-zipkin.md): 探索如何在 Apache APISIX 中使用 Zipkin 实施请求追踪，从而实现对请求流和性能诊断的详细监控。 #### security - [在 AWS Secrets Manager 中管理密钥](https://docs.apiseven.com/apisix/how-to-guide/security/secrets-management/manage-secrets-in-aws.md): 了解如何将 AWS Secrets Manager 与 Apache APISIX 结合使用，以安全地存储和管理敏感凭证，确保持自动轮换和安全访问。 - [在 GCP Secret Manager 中管理密钥](https://docs.apiseven.com/apisix/how-to-guide/security/secrets-management/manage-secrets-in-gcp-secret-manager.md): 了解如何将 GCP Secret Manager 与 Apache APISIX 集成，以集中管理 API 密钥和密码等密钥，并提供安全检索机制。 - [在 HashiCorp Vault 中管理密钥](https://docs.apiseven.com/apisix/how-to-guide/security/secrets-management/manage-secrets-in-hashicorp-vault.md): 了解如何将 HashiCorp Vault 与 Apache APISIX 集成，以安全管理敏感信息（包括 API 密钥和密码），以及如何在应用程序中检索这些密钥。 - [与 Coraza 集成](https://docs.apiseven.com/apisix/how-to-guide/security/waf/integrate-with-coraza.md): 探索 Coraza Web 应用程序防火墙 (WAF) 与 Apache APISIX 的集成，以增强安全性，提供针对各种网络攻击的强大保护。 #### service-discovery - [与 HashiCorp Consul 集成](https://docs.apiseven.com/apisix/how-to-guide/service-discovery/consul-integration.md): 了解如何设置 HashiCorp Consul 进行服务发现，并将其与 Apache APISIX 集成，以动态路由和负载均衡微服务的流量。 - [与 Netflix Eureka 集成](https://docs.apiseven.com/apisix/how-to-guide/service-discovery/eureka-integration.md): 探索如何配置 Netflix Eureka 进行服务发现，并将其与 Apache APISIX 集成，以无缝管理服务注册和路由。 #### traffic-management - [实施 API 版本控制](https://docs.apiseven.com/apisix/how-to-guide/traffic-management/api-versioning.md): 了解如何在 Apache APISIX 中使用路径、查询和标头策略实施 API 版本控制，以实现更好的 API 管理。 - [条件流量管理](https://docs.apiseven.com/apisix/how-to-guide/traffic-management/conditional-traffic-management.md): 探索如何在 Apache APISIX 中实施条件流量管理，根据请求特征（如标头或参数）启用动态路由和操作。 - [配置上游健康检查](https://docs.apiseven.com/apisix/how-to-guide/traffic-management/health-check.md): 了解如何在 Apache APISIX 中为上游服务配置主动和被动健康检查，确保仅将请求转发到健康的服务。 - [配置客户端和 APISIX 之间的 HTTP/3 QUIC](https://docs.apiseven.com/apisix/how-to-guide/traffic-management/http3-quic.md): 了解如何在 Apache APISIX 中配置 HTTP/3 连接，以利用 QUIC 的优势来提高性能并减少延迟。 - [代理传输层 (L4) 流量](https://docs.apiseven.com/apisix/how-to-guide/traffic-management/proxy-transport-layer-l4-traffic.md): 探索如何配置 Apache APISIX 来处理传输层 (L4) TCP 和 UDP 流量，从而实现各种类型的网络流量的高效代理。 - [代理 WebSocket 连接](https://docs.apiseven.com/apisix/how-to-guide/traffic-management/proxy-websocket.md): 了解如何启用 Apache APISIX 代理 WebSocket 连接，促进客户端和服务器之间的实时双向通信。 - [配置限流限速](https://docs.apiseven.com/apisix/how-to-guide/traffic-management/rate-limiting.md): 了解如何在 Apache APISIX 中使用各种插件设置限流限速，以控制对 API 的访问并保护它们免受过多请求的影响。 - [配置客户端和 APISIX 之间的 HTTPS](https://docs.apiseven.com/apisix/how-to-guide/traffic-management/tls-and-mtls/configure-https-between-client-and-apisix.md): 了解如何在客户端和 Apache APISIX 之间配置 HTTPS 以增强 API 安全性。 - [配置 APISIX 和上游之间的双向 TLS](https://docs.apiseven.com/apisix/how-to-guide/traffic-management/tls-and-mtls/configure-mtls-between-apisix-and-upstream.md): 了解如何在 Apache APISIX 和上游服务之间配置双向 TLS，以增强 API 安全性。 - [配置客户端和 APISIX 之间的双向 TLS](https://docs.apiseven.com/apisix/how-to-guide/traffic-management/tls-and-mtls/configure-mtls-between-client-and-apisix.md): 了解如何在客户端和 Apache APISIX 之间配置双向 TLS，以增强 API 安全性。 - [配置上游 HTTPS](https://docs.apiseven.com/apisix/how-to-guide/traffic-management/tls-and-mtls/configure-upstream-https.md): 了解如何在 Apache APISIX 中连接到 HTTPS 端口上的上游服务，以确保通信安全并增强 API 安全性。 - [实施流量镜像](https://docs.apiseven.com/apisix/how-to-guide/traffic-management/traffic-mirroring.md): 了解如何在 Apache APISIX 中设置流量镜像，允许你将传入流量复制到辅助服务进行测试或分析，而不影响主服务。 #### transformation - [将 JSON 转换为 XML](https://docs.apiseven.com/apisix/how-to-guide/transformation/convert-json-to-xml.md): 了解如何在 Apache APISIX 中使用 body-transformer 插件将 JSON 数据转换为 XML 格式，反之亦然，从而促进不同系统之间的数据交换。 - [将 HTTP 转换为 gRPC](https://docs.apiseven.com/apisix/how-to-guide/transformation/transcode-http-to-grpc.md): 了解如何在 Apache APISIX 中使用 grpc-transcode 插件在 RESTful HTTP 请求和 gRPC 请求之间进行转换，从而实现 gRPC 服务的无缝集成。 ### install #### docker 了解如何使用 Docker 安装 Apache APISIX，提供一种在容器化环境中部署和管理 API 网关的简单方法。 - [使用 Docker 安装 APISIX](https://docs.apiseven.com/apisix/install/docker.md): 了解如何使用 Docker 安装 Apache APISIX，提供一种在容器化环境中部署和管理 API 网关的简单方法。 - [构建自定义 Docker 镜像](https://docs.apiseven.com/apisix/install/docker/build-custom-images.md): 了解如何为 Apache APISIX 构建自定义 Docker 镜像，允许进行定制配置以满足你的特定部署需求。 #### kubernetes - [在 ROSA 上安装 APISIX](https://docs.apiseven.com/apisix/install/kubernetes/rosa.md): 按照步骤在 Red Hat OpenShift Service on AWS (ROSA) 上安装 Apache APISIX，这是一个用于部署 OpenShift 集群的完全托管服务。 ### key-concepts #### consumer-groups 了解 Apache APISIX 中消费者组的概念，它允许使用共享配置来管理多个消费者。 - [消费者组](https://docs.apiseven.com/apisix/key-concepts/consumer-groups.md): 了解 Apache APISIX 中消费者组的概念，它允许使用共享配置来管理多个消费者。 #### consumers 了解 Apache APISIX 中消费者的概念，它代表与 API 网关及其服务交互的用户或应用程序。 - [消费者](https://docs.apiseven.com/apisix/key-concepts/consumers.md): 了解 Apache APISIX 中消费者的概念，它代表与 API 网关及其服务交互的用户或应用程序。 #### credentials 了解 Apache APISIX 中凭证的概念，它管理消费者的身份认证配置以增强安全性和访问控制。 - [凭证](https://docs.apiseven.com/apisix/key-concepts/credentials.md): 了解 Apache APISIX 中凭证的概念，它管理消费者的身份认证配置以增强安全性和访问控制。 #### plugin-configs 了解 Apache APISIX 中插件配置的概念，它集中管理插件配置以提高 API 管理效率。 - [插件配置](https://docs.apiseven.com/apisix/key-concepts/plugin-configs.md): 了解 Apache APISIX 中插件配置的概念，它集中管理插件配置以提高 API 管理效率。 #### plugin-global-rules 了解 Apache APISIX 中全局规则的概念，它允许插件在每个传入请求上执行，以实现一致的 API 行为。 - [插件全局规则](https://docs.apiseven.com/apisix/key-concepts/plugin-global-rules.md): 了解 Apache APISIX 中全局规则的概念，它允许插件在每个传入请求上执行，以实现一致的 API 行为。 #### plugin-metadata 了解 Apache APISIX 中插件元数据的概念，它管理插件的共享配置，确保多个实例之间的一致性。 - [插件元数据](https://docs.apiseven.com/apisix/key-concepts/plugin-metadata.md): 了解 Apache APISIX 中插件元数据的概念，它管理插件的共享配置，确保多个实例之间的一致性。 #### plugins 了解 Apache APISIX 中插件的概念，它扩展了 API 操作中的流量管理、安全性和可观测性等功能。 - [插件](https://docs.apiseven.com/apisix/key-concepts/plugins.md): 了解 Apache APISIX 中插件的概念，它扩展了 API 操作中的流量管理、安全性和可观测性等功能。 #### protos 了解 Apache APISIX 中 Protos 的概念，它促进了服务之间的高效数据序列化和通信。 - [Protos](https://docs.apiseven.com/apisix/key-concepts/protos.md): 了解 Apache APISIX 中 Protos 的概念，它促进了服务之间的高效数据序列化和通信。 #### routes 了解 Apache APISIX 中路由的概念，它定义了通往上游服务的路径并促进了有效的流量管理。 - [路由](https://docs.apiseven.com/apisix/key-concepts/routes.md): 了解 Apache APISIX 中路由的概念，它定义了通往上游服务的路径并促进了有效的流量管理。 #### secrets 了解 Apache APISIX 中密钥管理的概念，它实现了 API 密钥等敏感信息的安全存储和管理。 - [密钥管理](https://docs.apiseven.com/apisix/key-concepts/secrets.md): 了解 Apache APISIX 中密钥管理的概念，它实现了 API 密钥等敏感信息的安全存储和管理。 #### services 了解 Apache APISIX 中服务的概念，它代表后端应用程序，并通过减少配置冗余来简化 API 管理。 - [服务](https://docs.apiseven.com/apisix/key-concepts/services.md): 了解 Apache APISIX 中服务的概念，它代表后端应用程序，并通过减少配置冗余来简化 API 管理。 #### ssl-certificates 了解 Apache APISIX 中 SSL 证书的概念，它确保客户端和 API 网关之间的安全通信。 - [SSL 证书](https://docs.apiseven.com/apisix/key-concepts/ssl-certificates.md): 了解 Apache APISIX 中 SSL 证书的概念，它确保客户端和 API 网关之间的安全通信。 #### stream-routes 了解 Apache APISIX 中四层路由的概念，它管理 TCP/UDP 流量，增强了网关对各种协议的处理能力。 - [四层路由](https://docs.apiseven.com/apisix/key-concepts/stream-routes.md): 了解 Apache APISIX 中四层路由的概念，它管理 TCP/UDP 流量，增强了网关对各种协议的处理能力。 #### upstreams 了解 Apache APISIX 中上游的概念，它管理后端服务地址以实现高效的负载均衡和服务发现。 - [上游](https://docs.apiseven.com/apisix/key-concepts/upstreams.md): 了解 Apache APISIX 中上游的概念，它管理后端服务地址以实现高效的负载均衡和服务发现。 ### migration #### nginx-to-apisix 按照指南从 NGINX 迁移到 Apache APISIX，确保平稳过渡，同时利用 API 网关的优势。 - [从 NGINX 迁移到 APISIX](https://docs.apiseven.com/apisix/migration/nginx-to-apisix.md): 按照指南从 NGINX 迁移到 Apache APISIX，确保平稳过渡，同时利用 API 网关的优势。 ### networking #### port-reference 探索 Apache APISIX 的默认端口配置，详细说明 API 网关中用于各种协议和服务的端口。 - [端口参考](https://docs.apiseven.com/apisix/networking/port-reference.md): 探索 Apache APISIX 的默认端口配置，详细说明 API 网关中用于各种协议和服务的端口。 ### production #### deployment-modes 了解 Apache APISIX 的各种部署模式，包括传统模式、解耦模式和独立模式，以优化你的 API 网关部署策略。 - [部署模式](https://docs.apiseven.com/apisix/production/deployment-modes.md): 了解 Apache APISIX 的各种部署模式，包括传统模式、解耦模式和独立模式，以优化你的 API 网关部署策略。 #### performance - [性能测试基准](https://docs.apiseven.com/apisix/production/performance/performance-testing.md): 探索对 Apache APISIX 进行性能测试的方法，确保你的 API 网关能够有效处理预期的流量负载。 #### recovery - [备份和恢复 etcd](https://docs.apiseven.com/apisix/production/recovery/etcd-backup-restore.md): 了解在 Apache APISIX 中备份和恢复 etcd 的最佳实践，确保 API 配置的数据完整性和可用性。 #### scaling - [在 AWS EC2 上自动扩缩容 APISIX 网关](https://docs.apiseven.com/apisix/production/scaling/autoscale-apisix-gateway-aws.md): 了解如何在 AWS EC2 上使用自动扩缩容组 (ASG) 自动扩缩容 APISIX 网关，以在不同的流量负载下保持一致的 API 性能。 - [自动扩展 APISIX 网关 (K8s)](https://docs.apiseven.com/apisix/production/scaling/autoscale-apisix-gateway-k8s.md): 了解如何使用水平 Pod 自动伸缩器（HPA）在 Kubernetes 上自动扩展 APISIX 网关，以在不同的流量负载下保持一致的 API 性能。 #### security - [Admin API 密钥](https://docs.apiseven.com/apisix/production/security/admin-api-key.md): 了解在 Apache APISIX 中配置 Admin API 密钥的重要性，确保对 Admin API 端点的安全访问并有效地管理权限。 - [使用 Keyring 加密数据](https://docs.apiseven.com/apisix/production/security/data-encryption-with-keyring.md): 了解 Apache APISIX 中数据加密的重要性，以及如何使用密钥环保护敏感信息以增强保护。 - [IP 限制](https://docs.apiseven.com/apisix/production/security/ip-restriction.md): 了解如何在 Apache APISIX 中实施 IP 限制以控制对资源的访问，通过仅允许授权的 IP 地址来增强安全性。 - [配置 APISIX 和 etcd 之间的 mTLS](https://docs.apiseven.com/apisix/production/security/mtls/configure-mtls-between-apisix-and-etcd.md): 了解如何在 Apache APISIX 和 etcd 之间配置双向 TLS，确保这些组件之间的通信和身份认证安全。 - [配置客户端和 APISIX Admin API 之间的 mTLS](https://docs.apiseven.com/apisix/production/security/mtls/configure-mtls-between-client-and-admin-api.md): 了解如何在客户端和 Apache APISIX Admin API 之间配置双向 TLS，以增强 API 管理的安全性。 #### serve-static-resources 了解如何配置 Apache APISIX 以高效地服务静态资源，从而提高 API 的性能和资源管理。 - [服务静态资源](https://docs.apiseven.com/apisix/production/serve-static-resources.md): 了解如何配置 Apache APISIX 以高效地服务静态资源，从而提高 API 的性能和资源管理。 #### upgrade - [灰度发布](https://docs.apiseven.com/apisix/production/upgrade/canary-deployment.md): 了解 Apache APISIX 中的灰度发布策略，允许逐步推出新功能，同时将风险降至最低。 ### reference #### a6-cli 了解单独安装的 a6 CLI 如何通过 Admin API 管理 Apache APISIX，以及它与其他管理工具的区别。 - [a6 CLI](https://docs.apiseven.com/apisix/reference/a6-cli.md): 了解单独安装的 a6 CLI 如何通过 Admin API 管理 Apache APISIX，以及它与其他管理工具的区别。 #### adc 使用 API 声明式 CLI（ADC）以声明方式管理 Apache APISIX 配置。 - [API 声明式 CLI（ADC）](https://docs.apiseven.com/apisix/reference/adc.md): 使用 API 声明式 CLI（ADC）以声明方式管理 Apache APISIX 配置。 #### api-standalone-usage 了解 Apache APISIX 中的 API 驱动独立模式用法，该模式将网关配置完全存储在内存中，而不是配置文件中。 - [API 驱动的独立模式](https://docs.apiseven.com/apisix/reference/api-standalone-usage.md): 了解 Apache APISIX 中的 API 驱动独立模式用法，该模式将网关配置完全存储在内存中，而不是配置文件中。 #### apisix-cli 探索 APISIX 命令行接口 (CLI)，这是一个旨在轻松管理和控制 APISIX 实例的工具。 - [APISIX CLI](https://docs.apiseven.com/apisix/reference/apisix-cli.md): 探索 APISIX 命令行接口 (CLI)，这是一个旨在轻松管理和控制 APISIX 实例的工具。 #### apisix-expressions 了解 APISIX 表达式，它结合了变量和运算符，用于路由匹配、请求过滤和其他功能。 - [APISIX 表达式](https://docs.apiseven.com/apisix/reference/apisix-expressions.md): 了解 APISIX 表达式，它结合了变量和运算符，用于路由匹配、请求过滤和其他功能。 #### apisix-mcp 使用 APISIX-MCP 向兼容 MCP 的 AI 客户端和 Agent 公开 Apache APISIX 资源操作及网关测试请求。 - [APISIX 模型上下文协议（APISIX-MCP）](https://docs.apiseven.com/apisix/reference/apisix-mcp.md): 使用 APISIX-MCP 向兼容 MCP 的 AI 客户端和 Agent 公开 Apache APISIX 资源操作及网关测试请求。 #### built-in-variables 探索 Apache APISIX 中的内置变量，它们提供对特定于请求的信息的访问，用于插件配置和路由。 - [内置变量](https://docs.apiseven.com/apisix/reference/built-in-variables.md): 探索 Apache APISIX 中的内置变量，它们提供对特定于请求的信息的访问，用于插件配置和路由。 #### configuration-files 了解 Apache APISIX 中的配置文件，详细说明如何为各种环境自定义参数。 - [配置文件](https://docs.apiseven.com/apisix/reference/configuration-files.md): 了解 Apache APISIX 中的配置文件，详细说明如何为各种环境自定义参数。 #### environment-variables 探索 Apache APISIX 中的环境变量，这些变量可以在部署期间启用可配置的设置，以增强灵活性。 - [环境变量](https://docs.apiseven.com/apisix/reference/environment-variables.md): 探索 Apache APISIX 中的环境变量，这些变量可以在部署期间启用可配置的设置，以增强灵活性。 #### file-standalone-configurations 了解 Apache APISIX 中的文件驱动独立配置，允许网关从 YAML 或 JSON 文件加载网关配置。 - [文件驱动的独立模式](https://docs.apiseven.com/apisix/reference/file-standalone-configurations.md): 了解 Apache APISIX 中的文件驱动独立配置，允许网关从 YAML 或 JSON 文件加载网关配置。 #### helm-chart 了解如何查找 Apache APISIX Helm Chart 的配置值，以及 Helm values 如何渲染为网关配置。 - [Helm Chart](https://docs.apiseven.com/apisix/reference/helm-chart.md): 了解如何查找 Apache APISIX Helm Chart 的配置值，以及 Helm values 如何渲染为网关配置。 #### plugin-common-configurations 探索 Apache APISIX 中的通用插件配置，通过 meta 属性为所有插件启用通用设置。 - [插件通用配置](https://docs.apiseven.com/apisix/reference/plugin-common-configurations.md): 探索 Apache APISIX 中的通用插件配置，通过 meta 属性为所有插件启用通用设置。 #### router-options 了解 Apache APISIX 中的路由选项，详细说明如何调整 API 请求处理的路由行为。 - [路由选项](https://docs.apiseven.com/apisix/reference/router-options.md): 了解 Apache APISIX 中的路由选项，详细说明如何调整 API 请求处理的路由行为。 ### troubleshooting #### debug-mode 在 Apache APISIX 中启用并配置调试模式,以有效检查运行时行为,日志细节,以及故障排除问题. - [使用调试模式](https://docs.apiseven.com/apisix/troubleshooting/debug-mode.md): 在 Apache APISIX 中启用并配置调试模式,以有效检查运行时行为,日志细节,以及故障排除问题. #### set-breakpoints 了解如何使用 APISIX inspect 插件，在不重启 APISIX 或修改源代码的情况下，捕获运行中工作进程里任意 Lua 代码行的局部变量和函数闭包变量。 - [设置断点](https://docs.apiseven.com/apisix/troubleshooting/set-breakpoints.md): 了解如何使用 APISIX inspect 插件，在不重启 APISIX 或修改源代码的情况下，捕获运行中工作进程里任意 Lua 代码行的局部变量和函数闭包变量。 ## enterprise-whitepaper ### tags - [标签](https://docs.apiseven.com/enterprise-whitepaper/tags.md) #### api-7-enterprise - [16 篇文档带有标签「API7 Enterprise」](https://docs.apiseven.com/enterprise-whitepaper/tags/api-7-enterprise.md) #### api-7-whitepaper - [16 篇文档带有标签「API7 Whitepaper」](https://docs.apiseven.com/enterprise-whitepaper/tags/api-7-whitepaper.md) #### architecture - [1 篇文档带有标签「Architecture」](https://docs.apiseven.com/enterprise-whitepaper/tags/architecture.md) #### authentication - [1 篇文档带有标签「Authentication」](https://docs.apiseven.com/enterprise-whitepaper/tags/authentication.md) #### canary-release - [1 篇文档带有标签「Canary Release」](https://docs.apiseven.com/enterprise-whitepaper/tags/canary-release.md) #### log-auditing - [1 篇文档带有标签「Log Auditing」](https://docs.apiseven.com/enterprise-whitepaper/tags/log-auditing.md) #### monitoring-and-alerting - [1 篇文档带有标签「Monitoring and Alerting」](https://docs.apiseven.com/enterprise-whitepaper/tags/monitoring-and-alerting.md) #### multi-tenancy - [1 篇文档带有标签「Multi-tenancy」](https://docs.apiseven.com/enterprise-whitepaper/tags/multi-tenancy.md) #### performance - [1 篇文档带有标签「Performance」](https://docs.apiseven.com/enterprise-whitepaper/tags/performance.md) #### protocol-conversion - [1 篇文档带有标签「Protocol Conversion」](https://docs.apiseven.com/enterprise-whitepaper/tags/protocol-conversion.md) #### refined-routing - [1 篇文档带有标签「Refined Routing」](https://docs.apiseven.com/enterprise-whitepaper/tags/refined-routing.md) #### service-governance - [1 篇文档带有标签「Service Governance」](https://docs.apiseven.com/enterprise-whitepaper/tags/service-governance.md) ### architecture Data Plane - [Architecture](https://docs.apiseven.com/enterprise-whitepaper/architecture.md): Data Plane ### feature-highlights API Management - [Feature Highlights](https://docs.apiseven.com/enterprise-whitepaper/feature-highlights.md): API Management ### features API and Service Governance - [Features](https://docs.apiseven.com/enterprise-whitepaper/features.md): API and Service Governance #### authentication API7 has built-in authentication authentication plugins such as key-auth, basic-auth, jwt-auth, etc. Taking HMAC plugin as an example, API7 can work with AK/SK to encrypt the request parameters to ensure that the request has not been tampered with. - [Authentication](https://docs.apiseven.com/enterprise-whitepaper/features/authentication.md): API7 has built-in authentication authentication plugins such as key-auth, basic-auth, jwt-auth, etc. Taking HMAC plugin as an example, API7 can work with AK/SK to encrypt the request parameters to ensure that the request has not been tampered with. #### canary-release Routing is the core function of the API gateway, which is used to route and match requests passing through the API gateway and forward them to the corresponding upstream service. When the upstream service finishes processing, the result is returned to the client. If a request does not match a route, the gateway will return a 404 status code because the route has not been published to the gateway or the route is not configured. - [Canary Release](https://docs.apiseven.com/enterprise-whitepaper/features/canary-release.md): Routing is the core function of the API gateway, which is used to route and match requests passing through the API gateway and forward them to the corresponding upstream service. When the upstream service finishes processing, the result is returned to the client. If a request does not match a route, the gateway will return a 404 status code because the route has not been published to the gateway or the route is not configured. #### log-auditing API7 has a built-in log auditing module, which collects system security events, administrator operation records, system operation logs, system operation status and other kinds of information in the information system centrally, and then stores and manages them centrally in the form of logs in a unified format after normalization, filtering and consolidation, combining with rich log statistical summary and correlation analysis functions to realize comprehensive auditing of information system logs. Through post-event analysis and reporting system, administrators can easily and efficiently conduct targeted security audits on information systems; when encountering special security events or configuration failures, the log auditing system can help administrators conduct rapid configuration positioning and rollback. Only administrators with authority can perform operation rollback. - [Log Auditing](https://docs.apiseven.com/enterprise-whitepaper/features/log-auditing.md): API7 has a built-in log auditing module, which collects system security events, administrator operation records, system operation logs, system operation status and other kinds of information in the information system centrally, and then stores and manages them centrally in the form of logs in a unified format after normalization, filtering and consolidation, combining with rich log statistical summary and correlation analysis functions to realize comprehensive auditing of information system logs. Through post-event analysis and reporting system, administrators can easily and efficiently conduct targeted security audits on information systems; when encountering special security events or configuration failures, the log auditing system can help administrators conduct rapid configuration positioning and rollback. Only administrators with authority can perform operation rollback. #### monitoring-alerting API7 records the basic information and status of each request. With the help of the statistical report page in the dashboard control panel, administrators can see the status of each service call, status code distribution, number of successes, number of failures, top 95 values, top 99 values and other information. It is convenient for administrators to understand the health of the system. In addition, the data plane will regularly report the traffic processing situation, and the administrator can view the gateway operation status and other indicators, such as error rate, number of requests, status code distribution, etc., within a certain time period through the control panel. When the administrator presets the alarm rules through the control panel, if the traffic reported by the gateway matches the rules, it will trigger the preset policies, such as sending station letters, email alerts, SMS and Webhook notifications, etc. - [Monitoring and Alerting](https://docs.apiseven.com/enterprise-whitepaper/features/monitoring-alerting.md): API7 records the basic information and status of each request. With the help of the statistical report page in the dashboard control panel, administrators can see the status of each service call, status code distribution, number of successes, number of failures, top 95 values, top 99 values and other information. It is convenient for administrators to understand the health of the system. In addition, the data plane will regularly report the traffic processing situation, and the administrator can view the gateway operation status and other indicators, such as error rate, number of requests, status code distribution, etc., within a certain time period through the control panel. When the administrator presets the alarm rules through the control panel, if the traffic reported by the gateway matches the rules, it will trigger the preset policies, such as sending station letters, email alerts, SMS and Webhook notifications, etc. #### multi-tenancy API7 has a built-in workspace module, super administrators need to create multiple workspaces, then create ordinary users and assign different permissions (in the configuration of permissions, you can bind workspace and resource permissions), so that the combination of the user system and permission management can achieve different users in different workspaces, different permissions for different resources, in order to achieve fine-grained control of resources permissions. - [Multi-tenancy](https://docs.apiseven.com/enterprise-whitepaper/features/multi-tenancy.md): API7 has a built-in workspace module, super administrators need to create multiple workspaces, then create ordinary users and assign different permissions (in the configuration of permissions, you can bind workspace and resource permissions), so that the combination of the user system and permission management can achieve different users in different workspaces, different permissions for different resources, in order to achieve fine-grained control of resources permissions. #### performance API7 adopts excellent performance solutions in all aspects from route matching, JSONSchema validation, and plugin operation. - [Performance](https://docs.apiseven.com/enterprise-whitepaper/features/performance.md): API7 adopts excellent performance solutions in all aspects from route matching, JSONSchema validation, and plugin operation. #### plugins API7 has more than 60 built-in common plugins, covering authentication, security protection, traffic control, analysis and monitoring, request/response conversion and many other categories. Some popular plugins are listed in the chart below. - [Plugins](https://docs.apiseven.com/enterprise-whitepaper/features/plugins.md): API7 has more than 60 built-in common plugins, covering authentication, security protection, traffic control, analysis and monitoring, request/response conversion and many other categories. Some popular plugins are listed in the chart below. #### protocol-conversion API7 exposes RESTful APIs uniformly to the outside world, which can be set by administrators in the control panel. These APIs correspond to microservices/upstream services in the enterprise and support proxies for protocols such as Dubbo, gRPC, WebServices, MQTT, etc., in addition to common HTTP services. - [Protocol Conversion](https://docs.apiseven.com/enterprise-whitepaper/features/protocol-conversion.md): API7 exposes RESTful APIs uniformly to the outside world, which can be set by administrators in the control panel. These APIs correspond to microservices/upstream services in the enterprise and support proxies for protocols such as Dubbo, gRPC, WebServices, MQTT, etc., in addition to common HTTP services. #### refined-routing API7 will triage the matched requests according to the preset weights and parameters. - [Refined Routing](https://docs.apiseven.com/enterprise-whitepaper/features/refined-routing.md): API7 will triage the matched requests according to the preset weights and parameters. #### service-governance API7 has built-in service governance features such as flow and rate limiting, service meltdown, IP blacklist and whitelist, and fault isolation. - [Service Governance](https://docs.apiseven.com/enterprise-whitepaper/features/service-governance.md): API7 has built-in service governance features such as flow and rate limiting, service meltdown, IP blacklist and whitelist, and fault isolation. ### highlights API7 Highlights - [Highlights](https://docs.apiseven.com/enterprise-whitepaper/highlights.md): API7 Highlights ### introduction API7.ai's API Gateway product (hereinafter referred to as API7) is built based on Apache APISIX, a top-level project of the Apache Software Foundation. API7 consists of 3 components: API Gateway, ManagerAPI and Dashboard Control Panel. - [Overview](https://docs.apiseven.com/enterprise-whitepaper/introduction.md): API7.ai's API Gateway product (hereinafter referred to as API7) is built based on Apache APISIX, a top-level project of the Apache Software Foundation. API7 consists of 3 components: API Gateway, ManagerAPI and Dashboard Control Panel. ### modules API7 mainly contains the following functional modules: - [Modules](https://docs.apiseven.com/enterprise-whitepaper/modules.md): API7 mainly contains the following functional modules: ## ingress-controller ### common-use-cases 了解网关插件生态支持的常见使用场景，以及如何通过 Ingress Controller 配置这些插件。 - [常见使用场景](https://docs.apiseven.com/ingress-controller/common-use-cases.md): 了解网关插件生态支持的常见使用场景，以及如何通过 Ingress Controller 配置这些插件。 ### configure-upstream-health-checks 了解如何通过 APISIX 或 API7 Ingress Controller 配置上游健康检查。 - [配置上游健康检查](https://docs.apiseven.com/ingress-controller/configure-upstream-health-checks.md): 了解如何通过 APISIX 或 API7 Ingress Controller 配置上游健康检查。 ### custom-plugins #### lua 了解如何在 Kubernetes 环境中将 Lua 自定义插件加载到网关，并通过 APISIX 或 API7 Ingress Controller 将插件应用到路由。 - [部署 Lua 自定义插件](https://docs.apiseven.com/ingress-controller/custom-plugins/lua.md): 了解如何在 Kubernetes 环境中将 Lua 自定义插件加载到网关，并通过 APISIX 或 API7 Ingress Controller 将插件应用到路由。 #### wasm 了解如何在 Kubernetes 环境中将 Wasm 自定义插件加载到网关，并通过 APISIX Ingress Controller 将插件应用到路由。 - [部署 Wasm 插件](https://docs.apiseven.com/ingress-controller/custom-plugins/wasm.md): 了解如何在 Kubernetes 环境中将 Wasm 自定义插件加载到网关，并通过 APISIX Ingress Controller 将插件应用到路由。 ### detect-upstream-protocol-appprotocol 了解如何通过 APISIX 或 API7 Ingress Controller 根据 appProtocol 的值自动配置上游协议。 - [使用 appProtocol 检测上游协议](https://docs.apiseven.com/ingress-controller/detect-upstream-protocol-appprotocol.md): 了解如何通过 APISIX 或 API7 Ingress Controller 根据 appProtocol 的值自动配置上游协议。 ### documentation 阅读 API7 与 APISIX Ingress Controller 文档，了解安装、操作指南、故障排查，以及通过 Ingress、Gateway API 和 APISIX CRD 动态管理网关流量的参考信息。 - [Ingress Controller 文档](https://docs.apiseven.com/ingress-controller/documentation.md): 阅读 API7 与 APISIX Ingress Controller 文档，了解安装、操作指南、故障排查，以及通过 Ingress、Gateway API 和 APISIX CRD 动态管理网关流量的参考信息。 ### high-availability 了解如何为 API7 或 APISIX Ingress Controller 配置领导者选举，在生产环境中启用高可用。 - [AIC 高可用](https://docs.apiseven.com/ingress-controller/high-availability.md): 了解如何为 API7 或 APISIX Ingress Controller 配置领导者选举，在生产环境中启用高可用。 ### installation #### gitops 规划 APISIX 或 API7 Ingress Controller 的 GitOps 部署，包括仓库结构、资源所有权、CRD 和凭证。 - [为 GitOps 做准备](https://docs.apiseven.com/ingress-controller/installation/gitops.md): 规划 APISIX 或 API7 Ingress Controller 的 GitOps 部署，包括仓库结构、资源所有权、CRD 和凭证。 - [使用 Argo CD 管理](https://docs.apiseven.com/ingress-controller/installation/gitops/argo-cd.md): 使用 Argo CD 安装 APISIX 或 API7 Ingress Controller，并采用稳定的 Webhook 证书、明确的 CRD 所有权和安全协调策略。 - [使用 Flux 管理](https://docs.apiseven.com/ingress-controller/installation/gitops/flux.md): 使用 Flux 和 HelmRelease 资源安装 APISIX 或 API7 Ingress Controller，并配置明确的 CRD 策略、漂移检测和验证。 #### openshift 按照本指南在 OpenShift 集群上部署 API7 Ingress Controller，确保为你的环境进行正确配置和设置。 - [在 OpenShift 上安装 API7 Ingress Controller](https://docs.apiseven.com/ingress-controller/installation/openshift.md): 按照本指南在 OpenShift 集群上部署 API7 Ingress Controller，确保为你的环境进行正确配置和设置。 ### production #### cross-namespace 了解如何使用 Gateway API 和 ReferenceGrant 在 Ingress Controller 中配置跨命名空间引用。 - [配置跨命名空间引用](https://docs.apiseven.com/ingress-controller/production/cross-namespace.md): 了解如何使用 Gateway API 和 ReferenceGrant 在 Ingress Controller 中配置跨命名空间引用。 ### proxy-grpc-traffic 了解如何通过 APISIX 或 API7 Ingress Controller 配置路由以代理 gRPC 流量。 - [代理 gRPC 流量](https://docs.apiseven.com/ingress-controller/proxy-grpc-traffic.md): 了解如何通过 APISIX 或 API7 Ingress Controller 配置路由以代理 gRPC 流量。 ### proxy-requests-to-a-service 了解如何通过 Ingress Controller 创建路由，将请求代理到示例 HTTP 上游服务并验证路由结果。 - [将请求代理到服务](https://docs.apiseven.com/ingress-controller/proxy-requests-to-a-service.md): 了解如何通过 Ingress Controller 创建路由，将请求代理到示例 HTTP 上游服务并验证路由结果。 ### proxy-tcp-traffic 了解如何通过 APISIX 或 API7 Ingress Controller 按端口代理 TCP 流量。 - [按端口代理 TCP 流量](https://docs.apiseven.com/ingress-controller/proxy-tcp-traffic.md): 了解如何通过 APISIX 或 API7 Ingress Controller 按端口代理 TCP 流量。 ### proxy-tcp-traffic-over-tls 了解如何通过 APISIX 或 API7 Ingress Controller 基于 SNI 配置路由以代理 TLS 上的 TCP 流量。 - [通过 SNI 代理 TLS 上的 TCP 流量](https://docs.apiseven.com/ingress-controller/proxy-tcp-traffic-over-tls.md): 了解如何通过 APISIX 或 API7 Ingress Controller 基于 SNI 配置路由以代理 TLS 上的 TCP 流量。 ### proxy-to-external-services 了解如何通过 APISIX 或 API7 Ingress Controller 将请求代理到 Kubernetes 集群外部托管的服务。 - [将请求代理到外部服务](https://docs.apiseven.com/ingress-controller/proxy-to-external-services.md): 了解如何通过 APISIX 或 API7 Ingress Controller 将请求代理到 Kubernetes 集群外部托管的服务。 ### proxy-to-weighted-backends 了解如何通过 APISIX 或 API7 Ingress Controller 配置加权路由，将流量分发到多个上游服务。 - [将请求代理到加权后端](https://docs.apiseven.com/ingress-controller/proxy-to-weighted-backends.md): 了解如何通过 APISIX 或 API7 Ingress Controller 配置加权路由，将流量分发到多个上游服务。 ### proxy-udp-traffic 了解如何通过 APISIX 或 API7 Ingress Controller 按端口代理 UDP 流量。 - [按端口代理 UDP 流量](https://docs.apiseven.com/ingress-controller/proxy-udp-traffic.md): 了解如何通过 APISIX 或 API7 Ingress Controller 按端口代理 UDP 流量。 ### proxy-websocket-connection 了解如何通过 APISIX 或 API7 Ingress Controller 配置路由以代理 WebSocket 连接。 - [代理 WebSocket 连接](https://docs.apiseven.com/ingress-controller/proxy-websocket-connection.md): 了解如何通过 APISIX 或 API7 Ingress Controller 配置路由以代理 WebSocket 连接。 ### reference #### annotations 了解注解如何扩展 Ingress Controller 中 Kubernetes Ingress 和 IngressClass 资源的功能，以配置路由、安全和网关行为。 - [注解](https://docs.apiseven.com/ingress-controller/reference/annotations.md): 了解注解如何扩展 Ingress Controller 中 Kubernetes Ingress 和 IngressClass 资源的功能，以配置路由、安全和网关行为。 #### configuration-file 配置 APISIX 或 API7 Ingress Controller 的日志、领导者选举、指标、同步、Gateway API 和 Webhook 设置。 - [配置文件](https://docs.apiseven.com/ingress-controller/reference/configuration-file.md): 配置 APISIX 或 API7 Ingress Controller 的日志、领导者选举、指标、同步、Gateway API 和 Webhook 设置。 #### crd-reference 探索 Ingress Controller 支持的自定义资源定义 (CRD) 的详细参考文档。 - [自定义资源定义 API 参考](https://docs.apiseven.com/ingress-controller/reference/crd-reference.md): 探索 Ingress Controller 支持的自定义资源定义 (CRD) 的详细参考文档。 #### examples 探索展示 Ingress Controller 资源配置的各种示例，帮助你根据自身环境有效调整设置。 - [配置示例](https://docs.apiseven.com/ingress-controller/reference/examples.md): 探索展示 Ingress Controller 资源配置的各种示例，帮助你根据自身环境有效调整设置。 #### helm-charts 了解用于部署 APISIX 和 API7 Ingress Controller 的 Helm Chart，包括它们的工作方式以及可配置 Chart values 的参考位置。 - [Helm Chart](https://docs.apiseven.com/ingress-controller/reference/helm-charts.md): 了解用于部署 APISIX 和 API7 Ingress Controller 的 Helm Chart，包括它们的工作方式以及可配置 Chart values 的参考位置。 #### ingress-and-gateway-api-support 了解 Ingress Controller 支持的 Gateway API 和 Ingress 资源及其当前功能。 - [Ingress 和 Gateway API 支持](https://docs.apiseven.com/ingress-controller/reference/ingress-and-gateway-api-support.md): 了解 Ingress Controller 支持的 Gateway API 和 Ingress 资源及其当前功能。 ### set-up-ingress-controller-and-gateway 了解如何快速部署和配置 API7 Ingress Controller 或 APISIX Ingress Controller，用于管理 Kubernetes 入站流量。 - [设置 Ingress Controller 和网关](https://docs.apiseven.com/ingress-controller/set-up-ingress-controller-and-gateway.md): 了解如何快速部署和配置 API7 Ingress Controller 或 APISIX Ingress Controller，用于管理 Kubernetes 入站流量。 ### tls-and-mtls #### configure-downstream-https 了解如何通过 APISIX 或 API7 Ingress Controller 配置网关接收来自客户端的 HTTPS 流量。 - [配置客户端与网关之间的 HTTPS](https://docs.apiseven.com/ingress-controller/tls-and-mtls/configure-downstream-https.md): 了解如何通过 APISIX 或 API7 Ingress Controller 配置网关接收来自客户端的 HTTPS 流量。 #### configure-downstream-mtls 了解如何通过 APISIX 或 API7 Ingress Controller 配置网关，要求客户端使用双向 TLS（mTLS）。 - [配置客户端与网关之间的 mTLS](https://docs.apiseven.com/ingress-controller/tls-and-mtls/configure-downstream-mtls.md): 了解如何通过 APISIX 或 API7 Ingress Controller 配置网关，要求客户端使用双向 TLS（mTLS）。 #### configure-upstream-mtls 了解如何通过 APISIX 或 API7 Ingress Controller 配置网关通过双向 TLS（mTLS）将流量转发到上游服务。 - [配置网关与上游之间的 mTLS](https://docs.apiseven.com/ingress-controller/tls-and-mtls/configure-upstream-mtls.md): 了解如何通过 APISIX 或 API7 Ingress Controller 配置网关通过双向 TLS（mTLS）将流量转发到上游服务。 #### proxy-to-https-upstream 了解如何通过 APISIX 或 API7 Ingress Controller 配置网关通过 HTTPS 将流量转发到上游服务。 - [将请求代理到 HTTPS 上游服务](https://docs.apiseven.com/ingress-controller/tls-and-mtls/proxy-to-https-upstream.md): 了解如何通过 APISIX 或 API7 Ingress Controller 配置网关通过 HTTPS 将流量转发到上游服务。 ### troubleshooting #### admission-webhook 了解 admission webhook 在应用 Ingress Controller 资源时可能返回的错误和警告消息，以及如何解决这些问题。 - [了解 Admission Webhook](https://docs.apiseven.com/ingress-controller/troubleshooting/admission-webhook.md): 了解 admission webhook 在应用 Ingress Controller 资源时可能返回的错误和警告消息，以及如何解决这些问题。 #### common-issues 了解如何识别和解决 APISIX 或 API7 Ingress Controller 中的常见问题。 - [常见问题与解决方案](https://docs.apiseven.com/ingress-controller/troubleshooting/common-issues.md): 了解如何识别和解决 APISIX 或 API7 Ingress Controller 中的常见问题。 #### configuration-synchronization 了解如何检查并排查 APISIX 或 API7 Ingress Controller 中的配置转换与同步问题。 - [排查 Manifest 转换与同步问题](https://docs.apiseven.com/ingress-controller/troubleshooting/configuration-synchronization.md): 了解如何检查并排查 APISIX 或 API7 Ingress Controller 中的配置转换与同步问题。 #### gateway-debug-mode 了解如何在 Kubernetes 环境中启用网关 Debug 模式，以便排查和观察网关运行时行为。 - [启用网关 Debug 模式](https://docs.apiseven.com/ingress-controller/troubleshooting/gateway-debug-mode.md): 了解如何在 Kubernetes 环境中启用网关 Debug 模式，以便排查和观察网关运行时行为。 ## portal ### next #### demo This page is used for API7 Portal Documentation's Next version. It is rendered in docs.api7.ai/portal/next/blank - [Blank](https://docs.apiseven.com/portal/next/demo.md): This page is used for API7 Portal Documentation's Next version. It is rendered in docs.api7.ai/portal/next/blank ### tags - [标签](https://docs.apiseven.com/portal/tags.md) #### api-7-portal - [1 篇文档带有标签「API7 Portal」](https://docs.apiseven.com/portal/tags/api-7-portal.md) ### background-information #### how-api7-portal-works - [api7-portal-architecture](https://docs.apiseven.com/portal/background-information/how-api7-portal-works/api7-portal-architecture.md) - [integrate-with-api-management-platform](https://docs.apiseven.com/portal/background-information/how-api7-portal-works/integrate-with-api-management-platform.md) - [network-resiliency-and-availability](https://docs.apiseven.com/portal/background-information/how-api7-portal-works/network-resiliency-and-availability.md) ### get-started #### developer - [analyze-api-usage](https://docs.apiseven.com/portal/get-started/developer/analyze-api-usage.md) - [call-subscribed-api](https://docs.apiseven.com/portal/get-started/developer/call-subscribed-api.md) - [discover-api](https://docs.apiseven.com/portal/get-started/developer/discover-api.md) - [get-developer-account](https://docs.apiseven.com/portal/get-started/developer/get-developer-account.md) - [manage-api-key](https://docs.apiseven.com/portal/get-started/developer/manage-api-key.md) - [subscribe-api-product](https://docs.apiseven.com/portal/get-started/developer/subscribe-api-product.md) #### provider - [access-developer-portal](https://docs.apiseven.com/portal/get-started/provider/access-developer-portal.md) - [analyze-api-usage](https://docs.apiseven.com/portal/get-started/provider/analyze-api-usage.md) - [get-provider-account](https://docs.apiseven.com/portal/get-started/provider/get-provider-account.md) - [manage-api-subscription](https://docs.apiseven.com/portal/get-started/provider/manage-api-subscription.md) - [publish-api-product](https://docs.apiseven.com/portal/get-started/provider/publish-api-product.md) ### how-to-guides #### security - [api7-portal-authentication](https://docs.apiseven.com/portal/how-to-guides/security/api7-portal-authentication.md) ### introduction 什么是 API7 Portal - [概览](https://docs.apiseven.com/portal/introduction.md): 什么是 API7 Portal