只需6个简单步骤，即可使用标准库和Node.js构建和部署API

API是软件的构建块&＃xff0c;它运行着我们的世界。 它们是软件系统相互通信的方式&＃xff0c;以及我们作为人们与软件进行通信的方式。 知道如何构建API不仅是软件开发人员的一项关键技能&＃xff0c;而且是一般编码知识的基础部分-一项可以帮助任何人职业发展的技能。

在本教程中&＃xff0c;您将学习如何使用在线API编辑器Standard Library上的代码直接从Web浏览器直接构建API&＃xff08;不需要其他工具&＃xff09;。 无论您是软件开发的新手&＃xff0c;还是正在寻找更快的代码发布方式的资深人士&＃xff0c;我都会向您演示如何快速使用Standard Library上的Code来构建有效的API。 我们将使用标准库上的代码来构建功能完善的SMS服务&＃xff0c;该服务连接AscenDB的Peaks API&＃xff08;用于识别山脉信息&＃xff09;和MessageBird的API&＃xff08;用于发送SMS消息&＃xff09; 。

我们的API将接收任何山峰的名称&＃xff0c;并从AscendDB中检索该山峰的海拔和突出程度。 AscenDB的Peaks API提供了全世界超过700万个峰的数据-您可以在Standard Library上查看其文档 。 您还可以使用您选择的任何API复制这些步骤&＃xff0c;以创建自己的SMS服务&＃xff01;

您需要什么

• 1个美国手机号码
• 1x创意大胆的灵魂

步骤1&＃xff1a;标准库中的代码入门

第一步是转到标准库上的代码 。 Standard Library上的代码是由Standard Library的团队构建的在线API编辑器&＃xff0c;这是一个可嵌入式开发环境&＃xff0c;可轻松构建API&＃xff0c;webhooks和工作流自动化任务。

在“标准库代码”的右上角&＃xff0c;单击&＃xff08;登录&＃xff09; 。 如果您有标准库帐户&＃xff0c;请单击“ 已注册”&＃xff0c;然后使用您的凭据登录。 将会弹出一个模块&＃xff0c;提示您声明名称空间 &＃xff08;这是您的用户名&＃xff09;。 输入您的电子邮件并选择一个密码。

创建帐户后&＃xff0c;将出现另一个模块&＃xff0c;其中列出了订阅计划。 免费帐户就是您开始所需的全部。

单击“ 订阅&＃43;赚取积分”后&＃xff0c;您应该会看到一条确认消息。

单击继续以返回到标准库登录页面上的代码。

步骤2&＃xff1a;与您的第一个API交互

• 单击创建新API&＃xff08;空白&＃xff09;
• 输入您的API的名称。 就本教程而言&＃xff0c;建议您将其命名为MyFirstAPI并单击“ 确定” &＃xff08;或按Enter&＃xff09;。

按下Enter键后&＃xff0c;您会在左侧边栏&＃xff08;文件夹树视图&＃xff09;中看到一个自动生成的服务项目支架。 此时&＃xff0c;您可能已经注意到内部有一个“ hello world” Javascript函数&＃xff08; __main__.js &＃xff09;。 要测试您的功能&＃xff0c;只需单击右下角的“运行” &＃xff1a;

单击“运行”&＃xff0c;只需几秒钟即可将您的功能转变为无限扩展的API端点&＃xff01; 在“结果”区域下&＃xff0c;您会注意到一个文档门户-单击它以在标准库中查看您API的信息。 您还将看到一个API端点URL&＃xff0c;单击它&＃xff0c;然后将打开一个新标签&＃xff0c;实时显示您的“ hello world”消息。

步骤3&＃xff1a;替换默认的“ Hello World”功能并设置您的 STDLIB_LIBRARY_TOKEN

现在&＃xff0c;让我们创建我们的SMS服务&＃xff0c;该服务将通过短信发送任何山峰的高程和突出信息。 首先&＃xff0c;我们将替换__main__.js的默认“ hello world”功能。 将下面提供的代码复制并粘贴到__main__.js文件中&＃xff1a;

将代码粘贴到__main__.js文件后&＃xff0c;您会注意到&＃xff0c;您对lib的依赖关系&＃xff08; require(&＃39;lib&＃39;)行&＃xff09;会自动添加&＃xff0c;无需通过终端运行npm安装-Standard上的代码库将自动修改您的package.json文件&＃xff0c;并将所有npm软件包安装到您的服务目录中。

如果仔细阅读我提供的代码&＃xff0c;您会发现lib的定义包含一个process.env.STDLIB_LIBRARY_TOKEN环境变量。 我们必须将必需的令牌添加到env.json文件中&＃xff0c;以使我们的服务正常工作。

导航到env.json文件&＃xff08;在左侧树视图中单击env.json &＃xff09;&＃xff0c;在那里您将看到"dev"和"release"环境正在等待您输入"STDLIB_LIBRARY_TOKEN" 。

将光标置于引号之间&＃xff08;请参见上面的屏幕&＃xff09;&＃xff0c;然后右键单击并选择Insert Library Token…&＃xff0c;或使用快捷键⌘&＃43;K。

选择“ 库令牌”以填写开发和发布环境。

确保使用“⌘&＃43; s”保存更改&＃xff08;或点击右下角的“ 保存 ”&＃xff09;。

步骤4&＃xff1a;索取免费的SMS MessageBird号码

我们就快到了&＃xff01; 接下来&＃xff0c;您将索取免费的MessageBird电话号码。 我们将使用MessageBird SMS API发送和接收短信。 标准库使您轻松地初始化号码&＃xff0c;发送和接收消息。

使标准库上的代码保持打开状态。 在另一个选项卡中&＃xff0c;导航到标准库上的MessageBird Numbers API并接受服务条款&＃xff08;顶部的橙色栏&＃xff09;。

完成之后&＃xff0c;您可以直接从浏览器中索取您的第一个电话号码&＃xff01; 向下滚动页面到numbers API上的available方法&＃xff1a;

当前&＃xff0c;只有加拿大和美国号码可用-根据您所在的位置选择适当的国家/地区代码&＃xff08;如果您想查看添加的特定地区或国家/地区&＃xff0c;请给我们发送电子邮件 &＃xff01;&＃xff09;从下拉列表中选择一个标准库令牌右边&＃xff08;应该显示Unauthenticated &＃xff09;&＃xff0c;然后按运行功能按钮以查看可用号码的列表。

从列表中复制一个电话号码&＃xff0c;然后再向下滚动一点到initialize方法。

API的initialize方法将要求一个初始电话号码供个人使用&＃xff0c;并且是免费的。 将您上面复制的数字输入到数字参数输入中&＃xff0c;从运行功能旁边的下拉列表中选择一个令牌&＃xff0c;然后按“运行功能”以声明您的数字。

恭喜你&＃xff01; 您已经在标准库上成功初始化了MessageBird&＃xff01; 您可以通过使用messagebird.sms服务发送文本消息来进行测试。 导航到MessageBird SMS API参考&＃xff0c;并尝试使用您的个人电话号码作为收件人的create功能-您应该从刚刚声明的号码中收到一条短信&＃xff01;

步骤5&＃xff1a;通过标准库上的代码测试服务

现在您已经索取了免费号码&＃xff0c;我们可以测试您的SMS服务。

返回到“ MyFirstAPI”服务中的__main__.js文件。 我们将填写右侧栏中要求参数的部分。 MessageBird将四个参数传递给SMS处理程序。 这些是接收消息的MessageBird编号&＃xff0c;它将是您先前声明的编号&＃xff0c;发送传入消息的外部号码&＃xff0c;消息的内容以及消息的发送时间。

sender:您的手机号码&＃xff0c;将接收短信

receiver:接收SMS的标准图书馆电话号码

message:您正在请求海拔和突出信息的山峰的名称。 &＃xff08;例如Denali &＃xff09;

createdDatetime:发送短信的日期

点击运行 。

在几秒钟内&＃xff0c;您将从您之前声明的MessageBird号码中收到一条短信。

相当整洁吧&＃xff1f; 但是我们还没有完成&＃xff01; 现在已经创建了您的服务&＃xff0c;我们将其设置为您先前声明的MessageBird电话号码的处理程序 。

步骤6&＃xff1a;使用MessageBird和标准库设置SMS消息响应处理程序

当您将服务设置为您刚刚使用MessageBird handlers API声明的号码的处理程序时&＃xff0c;只要该号码收到短信&＃xff0c;它就会触发。 我们将使用messagebird.handlers.sms.set API方法。 您可以直接从浏览器中执行此操作&＃xff01; 前往https://stdlib.com/&＃64;messagebird/lib/handlers/ 。

向下滚动&＃xff0c;直到看到两个参数number和identifier

Number:您在步骤4中声明的MessageBird号码

Identifier: .MyFirstAPI [&＃64;dev]

&＃xff08; 注意&＃xff1a; 当然是您的用户名&＃xff0c;“。MyFirstAPI [&＃64;dev]”假定您在初始步骤中将API命名为“ MyFirstAPI”&＃xff09;

输入所需参数后&＃xff0c;单击“运行功能” 。

就是这样&＃xff01; 要测试您的服务&＃xff0c;请向您的MessageBird号发送一条带有任何山脉名称的SMS消息。 您应该在几秒钟内收到回复&＃xff01;

您可以自定义处理程序&＃xff0c;以运行所需的任何类型的代码-并发回来自其他API的响应。 只需安装所需的任何npm软件包&＃xff0c;并使用所需的逻辑来修改functions/__main__.js处理程序。 您的SMS服务已准备就绪&＃xff0c;可以进行测试&＃xff01;

建议的步骤-清理代码

默认的示例API程序包&＃xff08;空白&＃xff09;可能包含一些不需要的额外终结点和文件&＃xff08;例如__main__.js终结点之外的functions/文件夹中的任何内容&＃xff09;&＃xff0c;您最终将需要清理它们。 要删除&＃xff08;和管理&＃xff09;文件&＃xff0c;请右键单击要删除的文件或文件夹&＃xff0c;然后点击删除 。

就是这样&＃xff0c;谢谢&＃xff01;

谢谢阅读&＃xff01; 我很高兴看到您想为标准库添加哪些精巧的服务。 您可以使用您选择的任何API复制这些步骤&＃xff0c;以创建一个很酷的服务&＃xff0c;例如此加密价格检查器 &＃xff01;

我希望您在这里发表评论 &＃xff0c; 给我发电子邮件给Janeth [at] stdlib [dot] com &＃xff0c;或者在Twitter上关注标准库&＃64;StdLibHQ 。 让我知道您是否建立了希望标准库团队展示或分享的精彩内容-我很乐意提供帮助&＃xff01;

珍妮丝·莱德兹玛&＃xff08;Janetth Ledezma&＃xff09;是标准图书馆社区经理&＃xff0c;最近刚从伯克利大学&＃xff08;UC Berkeley&＃xff09;毕业&＃xff0c;该死&＃xff01; 当她不学习阿拉伯语或锻炼时&＃xff0c;您可以在cbr500r上找到她探索城镇和咖啡馆的地方。 通过Twitter &＃64;mss_ledezma 跟随她的标准图书馆之旅 。

From: https://hackernoon.com/build-deploy-and-publish-an-api-using-code-xyz-and-node-js-in-6-steps-8aa3e8ec334b