node.js api环境_通过6个简单步骤构建和部署具有标准库和Node.js的API

node.js api环境

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

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

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

事先需要什么

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

步骤1:标准库中的代码入门

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

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

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

单击“ 订阅+赚取积分”后,您应该会看到一条确认消息。

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

步骤2:与您的第一个API交互

  • 单击创建新API(空白)
  • 输入您的API的名称。 就本教程而言,建议您将其命名为MyFirstAPI并单击“ 确定” (或按Enter键)。

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

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

步骤3:替换默认的“ Hello World”功能并设置您的 STDLIB_LIBRARY_TOKEN

现在,让我们创建我们的SMS服务,该服务将以短信形式发回任何山峰的高程和突出信息。 首先,我们将替换__main__.js的默认“ hello world”函数。 下面提供的代码复制并粘贴__main__.js文件中:

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

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

导航到env.json文件(在左侧树视图中单击env.json ),在那里您将看到"dev""release"环境正在等待您输入"STDLIB_LIBRARY_TOKEN"

在“ STDLIB_LIBRARY TOKEN”旁边的引号之间单击鼠标右键以打开上下文菜单

将光标置于引号之间(请参见上面的屏幕),然后右键单击并选择Insert Library Token…,或使用快捷键⌘+K。

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

确保使用“⌘+ s”保存更改(或点击右下角的“ 保存 ”)。

步骤4:索取免费的SMS MessageBird号码

我们就快到了! 接下来,您将索取免费的MessageBird电话号码。 我们将使用MessageBird SMS API发送和接收文本消息。 标准库使您轻松地初始化号码,发送和接收消息。

使标准库上的代码保持打开状态。 在另一个选项卡中,导航到“ 标准库”上MessageBird Numbers API,并接受服务条款(顶部的橙色栏)。

接受MessageBird服务条款-这是API参考顶部的橙色通知

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

MessageBird Numbers API中的“可用”方法

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

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

messagebird.numbers API中的“初始化”方法

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

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

messagebird.sms API中的“创建”方法

步骤5:通过标准库上的代码测试服务

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

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

sender:您的手机号码,将接收短信

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

message:您正在请求海拔和突出信息的山峰的名称。 (例如Denali

createdDatetime:发送短信的日期

点击运行

在几秒钟内,您将从您之前声明的MessageBird编号中收到一条短信。

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

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

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

向下滚动,直到看到两个参数numberidentifier

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

Identifier: <YOUR_USERNAME> .MyFirstAPI [@dev]

注: <YOUR_USERNAME>当然是您的用户名,“。MyFirstAPI [@dev]”假定您在初始步骤中将API命名为“ MyFirstAPI”)

输入所需参数后,单击“运行功能”

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

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

建议的步骤-清理代码

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

就是这样,谢谢!

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

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

珍妮丝·莱德兹玛(Janetth Ledezma)是标准图书馆的社区经理,最近从加州大学伯克利分校毕业。 当她不学习阿拉伯语或正在锻炼时,您可以在cbr500r上找到她正在探索的城镇和咖啡馆。 通过Twitter @mss_ledezma 跟随她的标准图书馆之旅

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

node.js api环境

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值