mcpField
A
api-gateway-configuration

api-gateway-configuration

github.com/secondsky云与 DevOps240416 次安装5 周前更新
代码仓库

关于 api-gateway-configuration

面向微服务架构的 API 网关设计与配置指南,列出网关职责,并以 Kong、Nginx 和 AWS API Gateway 为例展示配置方式。

主要功能

  1. 01请求路由与负载均衡
  2. 02身份验证与授权
  3. 03限流与节流
  4. 04请求和响应转换
  5. 05日志与监控
  6. 06SSL 终止

适用场景

  1. 01规划微服务 API 网关
  2. 02配置服务路由与负载均衡
  3. 03在网关层实施认证和限流
  4. 04设置 HTTPS、日志与健康检查

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/secondsky/claude-skills --skill api-gateway-configuration

安装后在 Claude Code 中输入/api-gateway-configuration确认已加载。

详细介绍

API 网关配置

为微服务架构设计和配置 API 网关。

网关职责

  • 请求路由和负载均衡
  • 身份验证和授权
  • 速率限制和流量管控
  • 请求/响应转换
  • 日志记录和监控
  • SSL 终止

Kong 配置(YAML)

_format_version: "3.0"

services:
  - name: user-service
    url: http://user-service:3000
    routes:
      - name: user-routes
        paths: ["/api/users"]
    plugins:
      - name: rate-limiting
        config:
          minute: 100
          policy: local
      - name: jwt

  - name: order-service
    url: http://order-service:3000
    routes:
      - name: order-routes
        paths: ["/api/orders"]

Nginx 配置

upstream backend {
    server backend1:3000 weight=5;
    server backend2:3000 weight=5;
    keepalive 32;
}

server {
    listen 443 ssl;

    location /api/ {
        proxy_pass http://backend;
        proxy_http_version 1.1;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_cache_valid 200 1m;
    }

    location /health {
        return 200 'OK';
    }
}

AWS API Gateway(SAM)

Resources:
  ApiGateway:
    Type: AWS::Serverless::Api
    Properties:
      StageName: prod
      Auth:
        DefaultAuthorizer: JWTAuthorizer
        Authorizers:
          JWTAuthorizer:
            JwtConfiguration:
              issuer: !Sub "https://cognito-idp.${AWS::Region}.amazonaws.com/${UserPoolId}"

最佳实践

  • 在网关层进行身份验证
  • 实施全局速率限制
  • 启用请求日志记录
  • 对后端使用健康检查
  • 有策略地应用响应缓存
  • 切勿在错误信息中暴露后端详情
  • 在生产环境中强制使用 HTTPS

评论

支持 Markdown