你是否在 Hashnode 或者 Dev.to 上写过技术帖子，又是否总想尝试新东西呢？如果是这样的话，有一件事情能帮你一解心头之痒：为开源项目做贡献。

我知道，我知道你肯定已经无数次在 Discord 群组里或在技术相关的社交媒体帖子中听到“为开源做贡献！”的呼吁。但是相信我，身为一名技术写作者，这真的是一个你积累经验的好方式。

一方面，你能参与一些公开展示的项目，这能帮助你向技术写作专业人士展现你的能力。

另一方面，和大家的普遍认识不同，实际上编写代码并不是为开源项目做贡献的唯一方式，你也可以利用自己的写作技能帮助项目维护者进行文档优化。

除此之外，为开源项目做贡献能够帮助你学习新的技术语言和软件，而这被美国劳工统计局描述为 技术写作者的重要技能之一。

还是无法说服你？没关系，在此指南中，我会探讨如何寻找需要技术写作者的开源项目，也会介绍通过技术写作能为开源项目做什么贡献，并且就如何公开展示这些贡献提出建议。

如何寻找需要技术写作贡献的开源项目

许多开源项目在文档方面都需要帮助，而你需要根据自己的兴趣、技术写作水平以及贡献机会来选择你将参与贡献的项目。

在寻找需要贡献的开源项目时，我强烈建议你向同事询问他们参与的项目。与朋友合作+参与开源项目，这难道不是一举两得吗！:) 在选择了项目之后，我建议你做这些事情：

1. 前往项目仓库的 Issues 选项卡。

2. 单击 Label 选项

3. 在文本框中输入 "documentation"，就可以啦！

现在如果你想寻找一些更具体的项目，我在这里列出了一些重点关注文档的开源项目：

The Good Docs Project

如果你正在寻找开源项目来积累文档写作的入门经验，我强烈建议你加入 这个群组. :) 他们有多个工作组，且关注不同类型的写作，包括创作文档模板供其他开发者在自己的开源项目中使用、优化组织的网站内容以及为社群成员已创建的模板做 QA （质量验证）。

Codecademy

如果你精通某种特定的编程语言并想向其他人分享相关知识，我强烈建议你为 Codecademy 的 文档 和 文章 仓库做贡献。他们基于不同需求提供模板，比如为特定章节提供新条目并更新/编辑现有条目。

Astro

如果你是 Astro 的狂热用户, 那你可以在他们的 docs repo 中分享该软件的使用建议，他们的文档组非常乐于与拥有不同经验水平的成员合作。

选择项目仅仅是其中一步，接下来让我们看看技术写作者为开源项目做贡献的不同方式。

技术写作者为开源做贡献的不同方式

恭喜！你已经选择了自己的贡献项目。现在，你需要决定如何利用自己的技术写作技能做贡献。

我知道这一步很难，但不要担心。现在，我们将讨论你能做出哪些不同类型的贡献。

修改 README 文件中的拼写错误和其他语法错误

README 文件是开源项目的重要基础，其中会描述项目的目标和贡献步骤，因此 README 文件应该尽可能表达清晰。

如果你在阅读 README 文件时发现逗号缺失或者句子表述不清，你可以向项目维护者发起 issue 并进行编辑（当然，前提是他们通过你发起的 issue）。

我在刚加入 EddieHub 社区的时候就是通过这种方式做贡献。这不仅仅是一种很好的自我介绍方式，也教会我根据特定受众来定制文档。当然，这不是为开源项目做文档贡献的唯一方式，让我们来看看另外一种方式！:)

创建内部文档风格指南

这需要创建一个指南，其中将定义某个开源项目文档的写作和格式标准，从而指导贡献者有效地进行开源项目的文档写作。

在该文档中，你将看见一些诸如标点符号的正确和错误书写方式、代码块格式化的特定方法以及产品文档的语气语调等信息。

Google 开发者文档中的缩写形式 便是一个很好的例子。

在看到 Document Write 的 YouTube 频道 中 Portia 的一则视频后，我决定撰写 一份针对 EddieHub 的 Linkfree 项目的文档风格指南。她在视频中谈论了开源贡献者，尤其想要将技术写作作为职业的贡献者，如何从这些风格指南中受益。

通过创建这份风格指南，我学到以下知识：

1. 以新的风格或语言编写: 由于 Linkfree 的主要受众来自英国，项目维护者希望使用英式英语来撰写风格指南。我之前从来没有使用过英式英语，所以需要重新学习单词的拼写、大写以及标点符号的使用，这是一个非常有趣的过程。
2. 使用新的技术工具或框架: MDX (Markdown X) 是贡献者用于维护 Linkfree 文档的一种技术语言。简单来说，你能在 Markdown 文档中使用 JSX （让你将 HTML 代码嵌入 JavaScript 的语法）。我曾短暂地使用过 Markdown，所以我能更轻松地使用这种语言来创建文档指南。

当然，撰写风格指南也只是为开源项目做文档贡献的其中一种方式，让我们再来看看另外一种方式吧！:)

添加产品教程

如果你善于指导他人，或者你在阅读开源软件教程时发现关键信息缺失，你可以考虑通过这种方式来做贡献。

Audacity 网站上的 tutorial 章节 就是一个很好的例子，而 Audacity 是一个免费的录音及音频编辑的开源软件。

作为开源社区的新人，我发现大多数入门级的内容并没有提供关于贡献者如何在找工作或面试时利用开源贡献经验的建议。因此，我在 Github 上浏览 OpenSauced 的仓库时，发现这些内容对于他们的 Intro to Open Source 免费课程很有帮助。

于是，我将这种想法传达给了公司的用户体验经理 Bekah，创建了一个拉取请求，并且最终 它被合并啦！

我强烈推荐你去做这种类型的贡献，因为练习的绝佳方式就是简化技术文档，使之便于全球不同技术水平的读者阅读。同时，这也能培养你注重细节的能力。

那么，在你着手通过参与开源贡献来积累技术写作经验之前，你现在还需要考虑一件事。

展示你的作品

当谈及展示作品的重要性时，Austin Kielon 说得最好：“展示你的作品吧”。

我想说的是，我们是大声疾呼的作者，通过文字展示内容是刻在我们骨子里的东西，那为什么不展示自己的作品呢？

你可以通过撰写博客、在社交媒体上发帖子，或者录制一集播客来展示你参与的项目。

如果你想通过一种更系统化的方式来展示作品，我推荐你使用 OpenSauced 免费的 Chrome 拓展插件。利用这款工具，你能追踪你正在做贡献以及计划做贡献的 GitHub 开源仓库。

除此之外，这款工具还具备 “Highlights” 功能，你可以选择将某些贡献发布到个人档案，并将它分享在领英和推特上。了解详细操作信息，请查阅 教程。

在你参加工作面试时，这些能作为你很好的作品参考。除此，这也能为其他开源贡献者提供灵感。在将我为 Linkfree 创建的文档风格指南分享到推特后，我的一位同事非常喜欢它，所以她认为为她的项目也创建一份文档风格指南是一个不错的做法。于是在她的邀请下，[我创建了一份文档风格指南]。(https://github.com/AccessibleForAll/AccessibleWebDev/blob/main/docs-style-guide.md)! :) 所以，永远不要低估展示作品的力量！

朋友们，这就是我为你们提供的关于如何通过参与开源贡献提升技术写作能力的指南。我知道，你在真正动手做的时候可能会害怕，尤其在刚开始的时候。但是，根据这些建议来实践并保持积极的态度，我相信你会成功的！

鸣谢

UXwing 提供的开源标志

Ylivdesign 在 Dreamstime上提供的技术写作图标

在云计算领域和 serverless 架构中，AWS API Gateway 是一款强大的工具，能帮助您搭建强大、安全且可拓展的 API。

在本教程中，首先我将介绍 API 网关是什么，并解释使用 API 网关的好处。接下来，我将展示如何创建、部署一个 Rest API, 并创建使用计划以提供 API 密钥。那么，我们现在就开始吧！

什么是 API 网关？

AWS API Gateway 是 Amazon Web Services (AWS) 提供的一项全托管服务，可帮助您轻松搭建、部署和管理任意规模的 API。

它充当应用程序的前门，允许您创建充当客户端和后端服务之间桥梁的 API，以便实现安全有效的通信。

为什么需要 API 网关？

AWS API Gateway 可为企业和开发者提供诸多好处，下方列出了一些使用 API 网关的好处。

可拓展性和高可用性

借助 AWS API Gateway，您可以更轻松地进行 API 拓展。通过底层基础设施自动拓展， AWS API Gateway 可以无缝处理流量高峰，以确保高可用性并避免服务中断。

安全与认证

API 网关提供强大的安全功能，包括内置的身份验证和授权机制。

它支持通过 IAM 角色对内部应用程序进行用户身份验证，通过 Cognito 对外部应用程序进行身份验证，并且支持自定义授权者。

与其他 AWS 服务集成

作为 AWS 生态系统的一部分， API 网关与一系列其他 AWS 服务无缝集成，这意味着您能利用 AWS Lambda 函数、用于用户管理的 AWS Cognito，以及用于监管和日志记录的 AWS CloudWatch 等其他功能。

API 生命周期管理

利用 API 网关，您能轻松对不同阶段的 API 进行版本控制、部署及管理。这简化了发布更新、测试新功能以及管理不同环境（比如开发、预生产和生产）的过程。

我希望现在您已经了解了 API 网关是什么以及它为何如此重要。接下来让我们一起来创建自己的 API 网关吧！

如何创建 AWS API Gateway

在本节中，我们将：

• 采用 GET 方法创建 Rest API
• 将其与简单的 hello world lambda 函数集成并进行部署

让我们从创建 lambda 函数开始吧

如何创建 AWS Lambda 函数

登录 AWS Management 控制台 并在控制台搜索栏中搜索 "Lambda"。然后，单击 Create Function 按钮。

选择 "Author from scratch" 选项，输入 lambda 函数名称，选择 "Python" Runtime，然后单击右下方的 Create Function 按钮。

函数创建成功后，请更新下方代码并部署更改：

import json

def lambda_handler(event, context):
    body = "Hello from 5minslearn!"
    statusCode = 200
    return {
        "statusCode": statusCode,
        "body": json.dumps(body),
        "headers": {
            "Content-Type": "application/json"
        }
    }

恭喜! 您已成功创建 AWS Lambda 函数，接下来让我们来创建 Rest API。

如何创建 Rest API 并将其与 AWS Lambda 集成

在搜索栏搜索 API Gateway，然后在 REST API 版块中单击 Build 按钮。

选择协议为 Rest，并在 Create new API 选项中选择 New API。在设置选项中输入您选择的 API 名称，并保留 Endpoint Type 的默认选项。然后，单击 Create API 按钮。

首先单击左上方的 Actions 按钮，然后单击 Method 并选择 GET 方法，再单击勾选图标。

选择 Lambda Function 作为 Integration type，并输入已创建的 Lambda 函数名称。然后，保存此函数。

单击保存后， 屏幕中将弹出 "Add Permission to Lambda Function"消息提示确认，这就意味着您将允许 API Gateway 调用 Lambda 函数（在本例中指的就是 "DemoFunction" Lambda 函数）。请同意确认，并继续下一步。

同意授权通过 API 网关调用 Lambda Function

单击 Test，您将来到一个新页面。单击 "Test" 按钮，此时您能在右侧面板上看到 Lambda 函数做出的响应。

在成功测试 API 后，您就能部署 API 了。要部署 API，请再次单击 Actions 按钮，然后单击 Deploy API。

此时屏幕上将弹出 Deploy API 的对话框，请选择 New Stage 作为 Deployment stage，并对其进行命名。然后，单击 Deploy 按钮。

单击页面顶部的 Invoke URL，您将看到 Lambda 做出的响应。

真棒! 我们已经成功创建了 Rest API，将其与 Lambda 函数集成并进行了部署。

但是，您可以通过市场中提供的多种服务来实现这个目标，那为什么要选择 AWS API Gateway 呢？

嗯，这是一个有趣的问题。首先，您可以利用 AWS API Gateway 为自己的 API 配置使用计划，而其中最突出的一点就是您无需为此编写任何代码。

现在就让我们来创建一个使用计划，生成一个 API 密钥，并仅通过在标头中传递 API 密钥来访问 Rest API。

如何创建 API Gateway 使用计划

在左侧边栏中单击 Usage Plans，然后单击 Create 按钮。输入您的计划名称，这里我选择了 "Basic"。根据您的需求在 Throttling 和 Quota 选项中输入相应数值，然后单击 Next。

单击 Add API Stage 按钮，并选择相应的 API 及其 Stage。然后，单击右上角的勾选图标，并选择 Next。

单击 "Create API Key and add to Usage Plan"，屏幕上将弹出一个对话框，请输入 API 密钥名称。而关于 API 密钥，我这里选择了 Auto Generate （自动生成），当然您也可以进行自定义。然后，单击 Save 按钮。

从侧边栏选择 Resources，单击已创建的 GET API，然后单击 Method Request。

在设置选项中，将 API Key Required 字段更新为 "true" 并单击勾选图标。更新后，务必点击 Actions 下拉菜单以部署更改。否则，变更将不会更新。

现在点击相同的 URL，你会发现神奇的事发生了。

Forbidden （禁止访问）！

因为现在我们的 API 层已受保护，您必须在标头中传递 API 密钥才能访问数据。

若未提供 API 密钥，则禁止访问。

现在单击侧边栏中的 Usage Plans，选择您的计划并导航至 API 密钥选项卡。

单击您在步骤 3 中创建的 API 密钥，然后单击 Show， 并复制此 API 密钥。

您必须在 'x-api-key' 标头中传递密钥。现在，让我们切换至终端来测试一下。

首先，测试一下在不传递 API 密钥的情况下 Rest API 的响应。打开终端，然后输入下方的 curl 命令。此时，您将再次看到“禁止访问”的消息。

curl --location --request GET '[enter your invoke url]'
--header 'Content-Type: application/json

终端中未提供 API 密钥的情况下禁止访问

现在再进行一次测试，在标头中传递 API 密钥，并运行下方 curl 命令：

curl --location --request GET '[your invoke url]' \
--header 'x-api-key: [your api key]' \
--header 'Content-Type: application/json' \
--data-raw ''

在 x-api-key 标头中传递 API 密钥时获取的数据

因为在标头中传递了 'x-api-key'，所以您能看到 Lambda 函数输出的结果。

真棒! 您已经成功创建了使用计划，生成了 API 密钥，并将其附加到 Rest API 方法中以及验证了集成。

总结

在本教程中，您学习了 AWS API gateway 是什么，以及如何为 Rest API 创建使用计划。

如果您想学习更多关于 AWS Services 的知识，可以订阅我的 email newsletter (https://5minslearn.gogosoon.com/) 并在社交媒体上关注我。