Express Gateway 使用教程

Express Gateway 使用教程

express-gatewayA microservices API Gateway built on top of Express.js项目地址:https://gitcode.com/gh_mirrors/ex/express-gateway

1. 项目的目录结构及介绍

Express Gateway 的目录结构如下：

express-gateway/
├── bin/
├── docs/
├── lib/
├── test/
├── .editorconfig
├── .eslintignore
├── .eslintrc.json
├── .gitignore
├── .npmignore
├── .nycrc
├── .travis.yml
├── CHANGELOG.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── app.js
├── package.json
└── server.js

目录介绍

• bin/: 包含可执行文件。
• docs/: 包含项目文档。
• lib/: 包含项目的主要代码。
• test/: 包含测试文件。
• .editorconfig, .eslintignore, .eslintrc.json, .gitignore, .npmignore, .nycrc, .travis.yml: 配置文件。
• CHANGELOG.md: 项目更新日志。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• app.js: 应用程序入口文件。
• package.json: 项目依赖和脚本配置。
• server.js: 服务器启动文件。

2. 项目的启动文件介绍

server.js

server.js 是 Express Gateway 的启动文件。它负责初始化并启动 API 网关。以下是 server.js 的主要内容：

const expressGateway = require('express-gateway');

expressGateway()
  .load(process.env.EG_CONFIG_DIR || process.cwd() + '/config')
  .run();

功能介绍

• require('express-gateway'): 引入 Express Gateway 模块。
• expressGateway(): 创建 Express Gateway 实例。
• load(process.env.EG_CONFIG_DIR || process.cwd() + '/config'): 加载配置文件。
• run(): 启动网关。

3. 项目的配置文件介绍

Express Gateway 的配置文件位于 config/ 目录下，主要包括以下文件：

• gateway.config.yml
• system.config.yml
• models/

gateway.config.yml

gateway.config.yml 是主要配置文件，定义了网关的路由、策略、服务等。

http:
  port: 8080
admin:
  port: 9876
apiEndpoints:
  api:
    host: '*'
    paths: '/ip'
serviceEndpoints:
  httpbin:
    url: 'https://httpbin.org'
policies:
  - proxy
pipelines:
  default:
    apiEndpoints:
      - api
    policies:
      - proxy:
          - action:
              serviceEndpoint: httpbin
              changeOrigin: true

system.config.yml

system.config.yml 包含系统级别的配置，如日志级别、插件配置等。

settings:
  keepAliveTimeout: 60000
  headersTimeout: 65000
  trustProxy: 'loopback'
  logger:
    level: 'info'

models/

models/ 目录包含数据模型的定义，如用户、策略等。

module.exports = {
  schema: {
    username: { type: 'string', required: true },
    password: { type: 'string', required: true }
  }
};

以上是 Express Gateway 的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

express-gatewayA microservices API Gateway built on top of Express.js项目地址:https://gitcode.com/gh_mirrors/ex/express-gateway