AWS Serverless Auth 参考应用启动与配置教程

1. 项目目录结构及介绍

AWS Serverless Auth 参考应用的目录结构如下：

aws-serverless-auth-reference-app/
├── api/                        # 包含API的源代码
│   ├── auth/                   # 认证相关的API
│   │   ├── login.js            # 登录API
│   │   └── logout.js           # 登出API
│   ├── dashboard/              # 仪表盘API
│   │   └── index.js            # 仪表盘主页API
│   └── users/                  # 用户管理API
│       └── index.js            # 用户管理API
├── client/                     # 前端应用代码
├── infra/                      # 基础设施代码，如CloudFormation模板
├── packages/                   # 项目依赖包
├── serverless/                 # Serverless Framework配置文件
│   ├── cloudformation-template.yaml # CloudFormation模板
│   └── serverless.yml          # Serverless Framework配置文件
└── test/                       # 测试代码

• api/: 包含所有后端API的Node.js代码。
• client/: 前端应用的代码，通常是React或其他前端框架。
• infra/: 包含AWS CloudFormation模板，用于部署和配置基础设施。
• packages/: 项目依赖包的存储位置。
• serverless/: 包含Serverless Framework的配置文件。
• test/: 包含测试代码，用于确保API和基础设施按预期工作。

2. 项目的启动文件介绍

在serverless/目录下，有两个主要的配置文件：

• cloudformation-template.yaml: 这是一个CloudFormation模板文件，用于定义AWS资源，例如Lambda函数、API网关和IAM角色。
• serverless.yml: 这是Serverless Framework的主配置文件，它描述了如何部署和管理AWS Lambda函数。

要启动项目，你需要使用Serverless Framework。首先，确保你已经安装了Serverless Framework。然后，在项目根目录下运行以下命令：

serverless deploy

这个命令将会根据serverless.yml文件的配置部署你的函数到AWS Lambda，并配置API网关。

3. 项目的配置文件介绍

项目的配置主要通过serverless.yml文件进行。以下是serverless.yml文件的一个基本示例：

service: aws-serverless-auth-reference-app

provider:
  name: aws
  runtime: nodejs12.x

functions:
  authLogin:
    handler: api/auth/login.login
  authLogout:
    handler: api/auth/logout.logout
  dashboardIndex:
    handler: api/dashboard/index.index
  usersIndex:
    handler: api/users/index.index

plugins:
  - serverless-plugin-typescript
  - serverless-plugin-output

在这个文件中，我们定义了服务名称、AWS提供商配置、函数及其处理程序，以及插件。每个函数都映射到API中的一个特定端点，并且配置了一个处理程序，这个处理程序指向api/目录下的相应JavaScript文件。

确保你已经配置了AWS的访问密钥，并且Serverless Framework已经配置了正确的AWS凭证。这样，当你运行serverless deploy命令时，Serverless Framework就能够将你的函数部署到AWS上。