MacOS使用Postman 测试接口:从 创建MySQL数据库到 Node 项目
这篇博客将涵盖以下步骤:
- 使用 Navicat 连接数据库并创建
users
数据表 - 在 MacOS 上启动 MySQL
- 使用 VSCode 编写一个 Node 项目
- 使用 Postman 测试接口
实现效果
1. 使用 Navicat 连接数据库并创建 users
数据表
首先,你需要使用 Navicat 连接到本地 MySQL 数据库,并创建一个 users
数据表,以下是详细步骤:
- 打开 Navicat,点击左上角的“连接”,选择“MySQL”。
- 在连接对话框中,输入连接信息:
- 连接名:
local_mysql
- 主机名:
localhost
- 端口:默认
3306
- 用户名:
root
- 密码:根据你安装 MySQL 时设置的密码。
- 连接名:
- 点击“连接测试”,如果成功,则点击“确定”保存连接。
接下来,创建 users
数据表:
- 右键点击数据库,选择“新建表”。
- 定义表结构:
CREATE TABLE users (id INT AUTO_INCREMENT PRIMARY KEY,username VARCHAR(50) NOT NULL,email VARCHAR(100) NOT NULL,password VARCHAR(100) NOT NULL,created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP );
- 点击“保存”,并确保表已成功创建。
2. 在 MacOS 上启动 MySQL
接下来,在 MacOS 上启动 MySQL 服务。
- 打开终端,输入以下命令以启动 MySQL:
sudo mysql.server start
- 使用以下命令登录到 MySQL:
mysql -u root -p
- 输入你的密码进入 MySQL 控制台。
确保 users
表在你的数据库中已创建成功:
USE your_database_name;
SHOW TABLES;
3. 使用 VSCode 编写一个 Node 项目
接下来,我们使用 VSCode 创建一个简单的 Node.js 项目,连接数据库并设置一个基础接口。
-
在终端中,进入到项目文件夹并初始化项目:
mkdir my-node-app cd my-node-app npm init -y
-
安装必需的依赖:
npm install express mysql body-parser
-
创建
app.js
文件,并写入以下代码:const express = require('express'); const mysql = require('mysql'); const bodyParser = require('body-parser');const app = express(); app.use(bodyParser.json());// 创建数据库连接 const db = mysql.createConnection({host: 'localhost',user: 'root',password: 'yourpassword',database: 'your_database_name' });db.connect(err => {if (err) {console.log('数据库连接失败:', err);return;}console.log('数据库连接成功'); });// 创建接口 app.get('/users', (req, res) => {const query = 'SELECT * FROM users';db.query(query, (err, results) => {if (err) {return res.status(500).send(err);}res.json(results);}); });app.listen(3000, () => {console.log('服务器启动,监听端口 3000'); });
-
在终端中启动服务器:
node app.js
服务器应该在 http://localhost:3000
上运行。
4. 使用 Postman 测试接口
步骤 1:安装并打开 Postman
- 如果你还没有安装 Postman,可以前往 Postman 官网 下载适用于 MacOS 的版本,并完成安装。
步骤 2:创建测试 API 请求
-
启动 Postman:
- 打开 Postman,点击“+”图标创建一个新请求。
-
设置请求 URL 和方法:
- 在 URL 栏中输入你的 API 地址,例如
http://localhost:3001/users
。 - 设置请求方法为
GET
(此请求方法用于获取users
表中的所有数据)。
- 在 URL 栏中输入你的 API 地址,例如
-
发送请求:
- 点击右侧的“发送”按钮。
- 如果你的服务器已经正常运行,Postman 将返回从数据库中提取的用户数据。返回结果应类似于:
[{"id": 1,"username": "john_doe","email": "john@example.com","password": "password123","created_at": "2024-10-10T12:34:56Z"},{"id": 2,"username": "jane_doe","email": "jane@example.com","password": "password456","created_at": "2024-10-10T12:45:12Z"} ]
步骤 3:测试不同的请求类型
- 你还可以在 Postman 中测试其他 HTTP 请求,如
POST
、PUT
和DELETE
。例如,可以创建一个POST
请求来添加新用户:
- 创建
POST
请求:- 在 Postman 中选择
POST
方法,并将 URL 设置为http://localhost:3001/users
。 - 在“Body”选项卡中,选择“raw”并设置为 JSON 格式。输入以下 JSON 数据:
{"username": "new_user","email": "newuser@example.com","password": "newpassword789" }
- 点击“发送”,服务器应返回新创建的用户信息,数据也将被插入到数据库中的
users
表。
- 在 Postman 中选择
步骤 4:验证数据库中数据的更新
- 使用 Navicat 或 MySQL 控制台,再次检查
users
表,确认新插入的数据已成功添加。
通过以上步骤,我们已经成功使用 Navicat 创建数据库和数据表,在 MacOS 上启动 MySQL,使用 VSCode 编写 Node.js 项目,并通过 Postman 测试了接口。这为你在开发 API 时提供了完整的流程示范。