如何轻松创建和托管您自己的 REST API,而无需编写任何代码
介绍
在本文中,您将了解如何轻松创建自己的 REST API 服务器,该服务器可在互联网上访问,无需编码,也无需将其托管在任何托管服务提供商上。
让我们开始吧
设置本地环境
- 创建一个名为 的新文件夹
users-api-server
。 - 从命令行导航到文件夹内并执行以下命令
npm init -y
package.json
这将在您的项目内创建一个文件。
json-server
执行以下命令安装npm 包
npm install json-server
-
创建一个名为的新文件,其中
.gitignore
包含条目,这样在将代码推送到 GitHub 存储库时,该文件夹就不会被推送到 GitHub。node_modules
node_modules
-
创建一个名为的新文件
db.json
并在其中添加以下内容:
{
"users": [
{
"id": 1,
"name": "David",
"age": 30
},
{
"name": "John",
"id": 2,
"age": 40
}
]
}
- 打开文件并在其中
package.json
添加以下部分:scripts
"scripts": {
"start": "json-server db.json"
}
-
npm start
现在,通过从终端运行命令来启动应用程序。
- 如果您点击
/users
该部分下的链接resources
,您将看到以下屏幕
提示:要获得如上所示的格式良好的 JSON 输出,请安装 JSON Formatter 浏览器扩展
-
恭喜!您无需编写任何代码,就编写了自己的 REST API 服务器
-
现在我们可以对我们自己的 API 进行、、
GET
和API调用。POST
PUT
PATCH
DELETE
发出 Get API 请求以获取所有用户
发出 POST API 请求以添加新用户
发出 PUT API 请求来更新用户
发出 DELETE API 请求来删除用户
保存更改
现在,您已经对我们的应用程序进行了一些 API 调用。
如果您想保存这些 API 调用的最终结果,您可以按下s
键盘上的键,然后按下该enter
键将更改的快照保存在单独的文件中,如终端中所示。
部署应用程序
部署使用的应用程序json-server
非常容易。
您只需创建一个 GitHub 存储库并将本地更改推送到该存储库,然后通过浏览器使用特定的 URL 访问它。
请按照以下步骤操作:
- 导航到此URL以创建新的 GitHub 存储库
- 输入您想要的存储库的名称,将其公开,然后单击
Create repository
按钮
- 您将看到以下屏幕
- 复制以下 URL:
git remote add
- 现在在你的项目中打开终端并首先执行
git init .(git init dot)
命令,然后在最后一步粘贴复制的 URL,然后按 Enter
- 这两个命令将使你的项目成为一个 git 仓库,并将你的本地 git 仓库指向 GitHub
-
因此,现在我们可以通过按顺序执行以下命令将更改推送到 GitHub
- git add --all 。
- git commit -m“你的提交信息”
- git push origin master
-
将更改推送到存储库后,您可以
json-server
通过导航到https://my-json-server.typicode.com/your_github_username/your_repository_name
例如https://my-json-server.typicode.com/myogeshchavan97/users-api来访问
就这样!您已将 API 实时部署到 Web 上,现在任何人都可以使用您的 API。
已部署
完整的 API
用户 API
json-server
注意:正如我们所见,要部署上线,实际上只需要db.json
在项目中创建一个文件即可。无需在文件json-server
中本地安装 npm 包package.json
。
我们在本地安装它,是为了在上线之前在本地测试我们的 API。
这样做的好处json-server
是,当你通过 URL 访问 API 时https://my-json-server.typicode.com/
,它不会更改原始db.json
文件。因此,每个用户都会获得相同的 API 副本db.json
。
仅当您使用本地测试时json-server
,原始db.json
文件才会被修改。
要了解更多信息,json-server
请点击此处
结论
正如您所见,通过db.json
在项目文件夹内创建文件并在该文件中提供 JSON 对象结构,您可以创建自己的 REST API 服务器,该服务器可在互联网上实时使用,甚至无需托管它。
您可以在此处找到此应用程序的完整源代码。
不要忘记订阅我的每周新闻通讯,其中包含精彩的提示、技巧和文章,直接发送到您的收件箱中。
链接:https://dev.to/myogeshchavan97/how-to-easily-create-and-host-your-own-rest-api-without-writing-a-single-line-of-code-2np4