构建 Serverless CRUD API-JavaScript中文网-JavaScript教程资源分享门户

随着云计算技术的发展，Serverless 架构在近年来越来越受到前端开发者的关注。Serverless 架构可以让开发者将注意力集中在业务逻辑上，而不用考虑服务器的管理和维护。在本文中，我们将介绍如何构建一个 Serverless 的 CRUD API，以管理一个简单的待办事项列表。

准备工作

在开始构建我们的 Serverless CRUD API 之前，我们需要准备一些工具和环境。我们将使用以下工具：

AWS Lambda：用于运行我们的 API 代码。
AWS API Gateway：用于将我们的 HTTP 请求路由到 Lambda 函数。
AWS DynamoDB：用于存储我们的待办事项列表。

我们还需要安装以下工具：

Node.js：用于编写我们的 Lambda 函数。
AWS CLI：用于配置我们的 AWS 环境。

在准备好以上工具和环境后，我们可以开始构建我们的 Serverless CRUD API。

创建 DynamoDB 表格

首先，我们需要在 AWS 控制台中创建一个 DynamoDB 表格，用于存储我们的待办事项列表。在创建表格时，我们需要指定一个主键，以便 DynamoDB 可以根据主键进行快速查询。

以下是创建 DynamoDB 表格的示例代码：

aws dynamodb create-table \
    --table-name todos \
    --attribute-definitions AttributeName=id,AttributeType=S \
    --key-schema AttributeName=id,KeyType=HASH \
    --billing-mode PAY_PER_REQUEST

在上述代码中，我们创建了一个名为 "todos" 的 DynamoDB 表格，并指定了一个名为 "id" 的主键。

创建 Lambda 函数

接下来，我们需要创建一个 Lambda 函数，用于处理我们的 HTTP 请求。我们将使用 Node.js 编写 Lambda 函数，并将其上传到 AWS Lambda 中。

以下是创建 Lambda 函数的示例代码：

// javascriptcn.com 代码示例
const AWS = require('aws-sdk');
const dynamodb = new AWS.DynamoDB.DocumentClient();

exports.handler = async (event) => {
    const { httpMethod, path, body } = event;
    
    switch (httpMethod) {
        case 'GET':
            return getTodos(path);
        case 'POST':
            return createTodo(JSON.parse(body));
        case 'PUT':
            return updateTodo(path, JSON.parse(body));
        case 'DELETE':
            return deleteTodo(path);
        default:
            return {
                statusCode: 405,
                body: 'Method Not Allowed'
            };
    }
};

function getTodos(path) {
    const params = {
        TableName: 'todos'
    };
    
    if (path !== '/') {
        params.KeyConditionExpression = 'id = :id';
        params.ExpressionAttributeValues = {
            ':id': path.substring(1)
        };
    }
    
    return dynamodb.query(params).promise()
        .then((data) => {
            return {
                statusCode: 200,
                body: JSON.stringify(data.Items)
            };
        })
        .catch((err) => {
            return {
                statusCode: 500,
                body: err.message
            };
        });
}

function createTodo(todo) {
    const params = {
        TableName: 'todos',
        Item: todo
    };
    
    return dynamodb.put(params).promise()
        .then(() => {
            return {
                statusCode: 200,
                body: JSON.stringify(todo)
            };
        })
        .catch((err) => {
            return {
                statusCode: 500,
                body: err.message
            };
        });
}

function updateTodo(path, todo) {
    const params = {
        TableName: 'todos',
        Key: {
            id: path.substring(1)
        },
        UpdateExpression: 'set #name = :name, #done = :done',
        ExpressionAttributeNames: {
            '#name': 'name',
            '#done': 'done'
        },
        ExpressionAttributeValues: {
            ':name': todo.name,
            ':done': todo.done
        },
        ReturnValues: 'ALL_NEW'
    };
    
    return dynamodb.update(params).promise()
        .then((data) => {
            return {
                statusCode: 200,
                body: JSON.stringify(data.Attributes)
            };
        })
        .catch((err) => {
            return {
                statusCode: 500,
                body: err.message
            };
        });
}

function deleteTodo(path) {
    const params = {
        TableName: 'todos',
        Key: {
            id: path.substring(1)
        }
    };
    
    return dynamodb.delete(params).promise()
        .then(() => {
            return {
                statusCode: 200,
                body: 'Todo deleted successfully'
            };
        })
        .catch((err) => {
            return {
                statusCode: 500,
                body: err.message
            };
        });
}

在上述代码中，我们编写了一个 Lambda 函数，用于处理 HTTP 请求。我们使用 AWS SDK 中的 DynamoDB.DocumentClient 类来访问 DynamoDB 表格。

配置 API Gateway

接下来，我们需要配置 API Gateway，用于将我们的 HTTP 请求路由到 Lambda 函数。

以下是配置 API Gateway 的示例代码：

// javascriptcn.com 代码示例
aws apigateway create-rest-api \
    --name todos-api \
    --endpoint-configuration types=REGIONAL

aws apigateway create-resource \
    --rest-api-id {api-id} \
    --parent-id {parent-id} \
    --path-part {path}

aws apigateway put-method \
    --rest-api-id {api-id} \
    --resource-id {resource-id} \
    --http-method GET \
    --authorization-type NONE

aws apigateway put-method \
    --rest-api-id {api-id} \
    --resource-id {resource-id} \
    --http-method POST \
    --authorization-type NONE \
    --request-parameters method.request.body=true

aws apigateway put-method \
    --rest-api-id {api-id} \
    --resource-id {resource-id} \
    --http-method PUT \
    --authorization-type NONE \
    --request-parameters method.request.body=true

aws apigateway put-method \
    --rest-api-id {api-id} \
    --resource-id {resource-id} \
    --http-method DELETE \
    --authorization-type NONE

aws apigateway put-integration \
    --rest-api-id {api-id} \
    --resource-id {resource-id} \
    --http-method GET \
    --type AWS_PROXY \
    --integration-http-method POST \
    --uri arn:aws:apigateway:{region}:lambda:path/2015-03-31/functions/{lambda-arn}/invocations

aws apigateway put-integration \
    --rest-api-id {api-id} \
    --resource-id {resource-id} \
    --http-method POST \
    --type AWS_PROXY \
    --integration-http-method POST \
    --uri arn:aws:apigateway:{region}:lambda:path/2015-03-31/functions/{lambda-arn}/invocations

aws apigateway put-integration \
    --rest-api-id {api-id} \
    --resource-id {resource-id} \
    --http-method PUT \
    --type AWS_PROXY \
    --integration-http-method POST \
    --uri arn:aws:apigateway:{region}:lambda:path/2015-03-31/functions/{lambda-arn}/invocations

aws apigateway put-integration \
    --rest-api-id {api-id} \
    --resource-id {resource-id} \
    --http-method DELETE \
    --type AWS_PROXY \
    --integration-http-method POST \
    --uri arn:aws:apigateway:{region}:lambda:path/2015-03-31/functions/{lambda-arn}/invocations

aws apigateway create-deployment \
    --rest-api-id {api-id} \
    --stage-name prod

在上述代码中，我们创建了一个名为 "todos-api" 的 REST API，并将其配置为路由 HTTP 请求到我们的 Lambda 函数。我们还创建了一个名为 "todos" 的资源，并将其与我们的 Lambda 函数关联。

测试 API

最后，我们可以测试我们的 Serverless CRUD API 是否正常工作。我们可以使用 curl 命令或 Postman 工具来测试我们的 API。

以下是测试 API 的示例代码：

// javascriptcn.com 代码示例
# 创建待办事项
curl -X POST https://{api-gateway-url}/todos --data '{"id": "1", "name": "Buy milk", "done": false}'

# 获取待办事项列表
curl https://{api-gateway-url}/todos

# 获取指定待办事项
curl https://{api-gateway-url}/todos/1

# 更新待办事项
curl -X PUT https://{api-gateway-url}/todos/1 --data '{"name": "Buy bread", "done": true}'

# 删除待办事项
curl -X DELETE https://{api-gateway-url}/todos/1

在上述代码中，我们使用 curl 命令测试我们的 Serverless CRUD API 是否正常工作。我们可以看到，我们的 API 可以成功创建、获取、更新和删除待办事项。

总结

在本文中，我们介绍了如何构建一个 Serverless 的 CRUD API，以管理一个简单的待办事项列表。我们使用了 AWS Lambda、AWS API Gateway 和 AWS DynamoDB 等工具和服务，以实现我们的 Serverless 架构。我们还提供了示例代码和测试代码，以帮助读者更好地理解和应用本文的内容。希望本文对读者有所帮助，让读者更好地掌握 Serverless 架构的知识和技能。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/650f4b0995b1f8cacd81d980