express的基础使用,利用postman模拟后端路由

最新推荐文章于 2024-03-25 09:38:50 发布
最新推荐文章于 2024-03-25 09:38:50 发布
阅读量571 收藏 6
点赞数 8
文章标签： express postman 测试工具
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/killsime/article/details/135314896
版权

简介

Node.js 使 JavaScript\TypeScript 脚本能够脱离浏览器环境在服务端（后端）运行（实际上是对 Chrome V8 引擎进行了封装），为我们开发后端提供了一种选项。不像前端有统一的浏览器标准，如果不遵循的话浏览器就没法正常显示；后端的开发相对就自由许多，开发语言有很多选项，如 Java，PHP，python，C，Go 等，我们科协网站采用的是 TypeScript 语言，有关 TypeScript 的知识在之前课程当中已有介绍。

如想自己动手建立一个简单后端，理论上只需调用 http-server 之类的库就能接收和发送 http 请求了。尽管这些库已经帮我们处理了很多底层问题，但是要想实现复杂一些的功能还是相当麻烦的。Express 是一个基于 Node.js 的开源框架，把接收和发送 http 请求进行了更高级别、更用户友好的封装。官网上称其“快速、开放、极简”，表明 Express 在保证性能的同时，代码书写非常容易且是开源的。它能够使用开发者所选择的各种 http 实用工具和中间件，快速方便地创建强大的 API。

配置环境

安装express

使用yarn来安装,如下

yarn init#取号名字,一路默认
yarn add express

准备工作

在刚才创建的安装有 Express 的工作目录当中，我们新建一个文件夹 src，用于保存源码，并在其中新建入口文件 app.ts。然后在其中导入 Express 包并创建 Express 类的实例：

import express from "express"; // 导入Express包
const app = express(); // 创建Express类的实例

这样导入的 Express 包是 JavaScript 编写的，缺乏 TypeScript 语法所要求的类型声明文件，因此会在 import 那一行出现提醒。我们可以使用如下命令安装类型声明：

yarn add @types/express --dev

安装完成后，我们看到提醒已经消除。

之后我们让程序监听 3000 端口，这样发送至 http://localhost:3000 的请求就能够被我们捕获了。

const port = 3000
app.listen(port, () => {
    // 开始监听
    console.log(`listening on port ${port}`);
});

问题来了，我们如何才能运行后端呢？我们可以使用babel

首先安装工具

yarn add @babel/core @babel/cli @babel/preset-env @babel/preset-typescript @babel/node nodemon --dev

其次，我们对 Babel 进行配置。在工作目录下新建 babel.config.json 文件，并向其中写入（删去注释）：

{
  "presets": [
    // 指定要使用的工具集。更多配置详见官方文档：https://www.babeljs.cn/docs/
    "@babel/preset-env",
    "@babel/preset-typescript"
  ]
}

然后，我们对 nodemon 进行配置。打开工作目录下的 package.json 文件，向其中新建一个如下字段（删去注释）：

"nodemonConfig": {      // 更多配置详见官方文档：https://www.npmjs.com/package/nodemon
    "watch": [          // 监听的文件目录
      "src"
    ],
    "ext": "ts, json",  // 监听的文件后缀
    "exec": "babel-node --extensions \".ts\" src/app.ts"    // 当运行nodemon命令时执行
    // babel-node与node的区别在于应用了babel.config.json中配置的工具，src/app.ts是你的入口文件
  }

最后，我们设定 yarn 的执行脚本以简单运行 node_modules 中的程序。在 package.json 文件中新建一个如下字段（删去注释）：

"scripts": {
    "start": "nodemon"  // 等价于./node_modules/nodemon/bin/nodemon.js
  }

这样，只要我们在终端中输入 yarn start，就会看到 nodemon 启动并用 Babel 生成和运行了 JavaScript 代码。此时输入 rs 回车，会使后端重启；摁下 Ctrl+C，会使后端停止。

Postman

安装

Postman 是一个 API 调试工具，可以模拟前端向后端发送请求，这在我们开发后端时非常有用。大家可以进入其官网注册账号（好处是你的 HTTP 请求会被备份并同步在不同设备）https://www.postman.com/，然后点击download desktop app 相关选项或者直接链接到https://www.postman.com/downloads/，下载安装程序并安装。

打开 Postman 并登录后，可以在 Collections 中点击加号，新建一个 Collection，然后在上方栏中点击加号，新建一个 Request 并保存到这个 Collection。这样就可以编辑、保存和发送这个 Request 了。针对同一类 API 的 Request 可以保存在同一个 Collection 下以方便管理。建议大家阅读 Postman 官方文档（https://learning.postman.com/docs/getting-started/introduction/）以学习更多Postman的实用知识。

使用

新建一个request,然后填写本地ip:port

http://localhost:3000/

然后就可以发送一个get请求,可以得到一个error,因为我们还没有路由处理这个请求,后面会介绍路由的具体用法

HTTP

HTTP 请求基本结构

要想弄清楚 Express 是如何路由的，有必要先了解 HTTP 请求的格式与结构。HTTP（超文本传输协议）基于 TCP/IP 协议来传递数据，是为客户端与服务器之间的通信而设计的。客户端请求的格式如下：

客户端请求格式

服务器响应的格式如下：

服务器响应格式

Express 根据的是 HTTP 请求方法和 URI/URL 来进行路由，由开发者编写的 API 处理请求后将状态码和其他响应内容发回客户端。下面先来了解一下 HTTP 请求方法：

序号方法描述
1GET向指定资源发出请求，用于获取资源，数据被包含在 URL 中
2HEAD等同于向服务器发送 GET 请求，但不获取响应包体，只获取响应头
3POST向指定资源提交数据进行处理请求（例如提交表单或者上传文件），数据被包含在请求体中
4PUT向指定资源处上传其最新内容
5DELETE请求服务器删除 Request-URL 所标识的资源
6CONNECTHTTP/1.1 协议中预留给能够将连接改为管道方式的代理服务器
7OPTIONS返回服务器针对特定资源的支持，允许客户端查看服务器的性能
8TRACE回显服务器收到的请求，主要用于测试或诊断
9PATCH是对 PUT 方法的补充，用来对已知资源进行局部更新

一般我们常用的是 GET、POST 和 PUT 请求。接着我们来了解一下 HTTP 响应状态码，下表列举了一些可能遇到的状态码及描述：

状态码英文描述中文描述
200OK请求成功
400Bad Request客户端请求的语法错误，服务器无法理解
401Unauthorized客户端请求的身份认证缺失或有误，认证失败
403Forbidden服务器理解请求客户端的请求，但是拒绝执行此请求
404Not Found服务器无法根据客户端的请求找到资源（网页）
500Internal Server Error服务器内部错误，无法完成请求
501Not Implemented服务器不支持请求的功能，无法完成请求
502Bad Gateway作为网关或者代理工作的服务器尝试执行请求时，从远程服务器接收到了一个无效的响应

HTTP URL

URL = uniform resource locator，即统一资源定位系统，是在网络上标识地址的方法。具体在 HTTP 协议的应用上，形式如下：

http://[host]:[port]/[path]?[searchpart]

其中，<port>默认为 80（对于 HTTPS 协议默认为 443），<path>是一个 HTTP 选择器，<searchpart>是查询字符串。例如：

https://baike.baidu.com/item/%E7%BB%9F%E4%B8%80%E8%B5%84%E6%BA%90%E5%AE%9A%E4%BD%8D%E7%B3%BB%E7%BB%9F/5937042?fromtitle=url&fromid=110640

协议是https，主机地址是baike.baidu.com（会被 DNS 解析成 IP 地址），采用默认的443端口；路径为/item/%E7%BB%9F.../5937042，其中带有路径参数/%E7%BB%9F.../5937042；查询字符串为fromtitle=url&fromid=110640。

路由

简介

解析url的过程就是路由,我们就是通过匹配url的过程来实现对前端请求的响应的

基本用法

路由的基本格式是：

app.METHOD(PATH, HANDLER);

其中：

  • app 是 express 类的实例。
  • METHOD 是 HTTP 请求方法。
  • PATH 是服务器上的路径。
  • HANDLER 是在路由匹配时执行的函数。

注意,这里这个参数的数量是不固定的,后面的用法里面还会有3参数,4参数的情况

例如：

// “/”路径接收到的GET方法匹配至该路由
app.get("/", (req, res) => {
  res.status(200).send("GET request");
});

// “/”路径接收到的POST方法匹配至该路由
app.post("/", (req, res) => {
  res.status(200).send("POST request");
});

// “/”路径接收到的所有方法匹配至该路由
app.all("/", (req, res) => {
  res.status(200).send("Any request");
});

对于 Handler 函数，Express 会在路由匹配时调用，调用时传进的参数有三个（一般依次命名为 req、res、next）：

  • req 对象代表“请求”，常用的属性是 body（请求的包体）、query（请求的查询字符串）和 params（请求的路径参数）；
  • res 对象代表“响应”，常用的方法是 status（设定响应状态码）和 send（设定响应内容）；
  • next 函数在调用时表示移交给下一个中间件进行处理。

匹配路径

匹配路径可以是普通字符串、字符串模板和正则表达式。

普通字符串如：

app.get("/", (req, res) => {
  // 可匹配“/”
  res.send("root");
});
app.get("/about", (req, res) => {
  // 可匹配“/about”
  res.send("about");
});
app.get("/random.text", (req, res) => {
  // 可匹配“/random.text”
  res.send("random.text");
});

字符串模板如：

app.get("/ab?cd", (req, res) => {
  // 可匹配“acd”或“abcd”
  res.send("ab?cd");
});
app.get("/ab+cd", (req, res) => {
  // 可匹配“abcd”,“abbcd”,“abbbcd”等
  res.send("ab+cd");
});
app.get("/ab*cd", (req, res) => {
  // 可匹配“abcd”,“abxcd”,“abRANDOMcd”,“ab123cd”等
  res.send("ab*cd");
});
app.get("/ab(cd)?e", (req, res) => {
  // 可匹配“abe”或“abcde”
  res.send("ab(cd)?e");
});

正则表达式如：

app.get(/a/, (req, res) => {
  // 可匹配任何带有‘a’的路径
  res.send("/a/");
});
app.get(/.*fly$/, (req, res) => {
  // 可匹配“butterfly”,“dragonfly”
  res.send("/.*fly$/"); // 但不可匹配“butterflyman”,“dragonflyman”
}); // 相当于匹配以“fly”结尾的所有路径

查询字符串

路径中的参数（route parameter）是指将参数直接作为 URL 路径一部分的传参方式，也就是我们前面的路径

查询字符串（query string）是 URL 在路径后面用?分割的部分，二者虽然都是在 URL 中传递参数，但用法不同。

仍举上述 URL 的例子：https://baike.baidu.com/item/%E7%BB%9F%E4%B8%80%E8%B5%84%E6%BA%90%E5%AE%9A%E4%BD%8D%E7%B3%BB%E7%BB%9F/5937042?fromtitle=url&fromid=110640。则可通过以下路由解析：

app.get("/item/:param1/:param2", (req, res) => {
  console.log(req.params.param1); // 统一资源定位系统,中间那段%unicode编码的翻译
  console.log(req.params.param2); // 5937042
  console.log(req.query.fromtitle); // url
  console.log(req.query.fromid); // 110640
  res.status(200).send("ok");
});

此外还有一些高级用法，如在路径中插入短线(-) 和点 (.)，甚至在路径中引入正则表达式：

// Request URL: http://localhost:3000/flights/LAX-SFO
app.get("/flights/:from-:to", (req, res) => {
  console.log(req.params.from); // LAX
  console.log(req.params.to); // SFO
  res.status(200).send("ok");
});

// Request URL: http://localhost:3000/date/2020.2.1
app.get("/date/:year.:month.:day", (req, res) => {
  console.log(req.params.year); // 2020
  console.log(req.params.month); // 2
  console.log(req.params.day); // 1
  res.status(200).send("ok");
});

路由处理函数

Express 的路由处理函数十分灵活，可以传递多个函数、函数数组或二者的混合。当需要从上一个处理函数过渡到下一个处理函数时，需调用传入的 next 函数。

var cb0 = function (req, res, next) {
  console.log("CB0");
  next();
};

var cb1 = function (req, res, next) {
  console.log("CB1");
  next();
};

app.get(
  "/example/d",
  [cb0, cb1],
  function (req, res, next) {
    console.log("the response will be sent by the next function ...");
    next();
  },
  (req, res) => {
    res.send("Hello from D!");
  }
);

Router

express.Router 类可以用于构建模块化的路由处理函数（中间件）

我们在 src 文件夹下面新建一个 route1.ts 文件，然后写入：

import express from "express";
const router = express.Router(); // 实例化express.Router类

router.get("/", (req, res) => {
  res.status(200).send("ok!");
});

export default router; // 导出后，这个Router就成为了一个中间件

然后修改 app.ts 类：

import express from "express";
import route1 from "./route1"; // 导入route1中间件

const app = express();
const port = 3000;

app.use("/route1", route1); // 在route1路径下使用route1中间件

app.listen(port, () => {
  console.log(`Example app listening on port ${port}`);
});

中间件

中间件是模块化的路由处理函数，我们刚才已经看到了路由级中间件的用法（通过 express.Router 创建中间件，然后通过 app.use 导入中间件），此外广义上刚才讲过的所有路由处理函数也都可以视为是最普通的中间件。在创建和使用中间件时，还有以下注意事项：

用 app.use 加载的中间件无论什么 HTTP 请求方法都会调用，如想限定一种 HTTP 请求方法，需使用 app.METHOD。同时，如果没有给出路径参数，则默认任何路径的请求都会调用中间件。

中间件是按顺序加载和执行的，如果前面已经出现了匹配的路由，那么后面的路由即使匹配，也不会调用相应的中间件。next 函数默认将控制权移交给当前路由的下一个处理函数，如想将控制权移交给下一个路由，需调用 next(‘route’)。如果将非"route"的参数传递给了 next 函数，则 Express 会认为该中间件出错，从而越过其他的正常处理函数直接执行异常处理函数。

app.get(
  "/user/:id",
  (req, res, next) => {
    // if the user ID is 0, skip to the next route
    if (req.params.id === "0") next("route");
    // otherwise pass the control to the next middleware function in this stack
    else next();
  },
  (req, res, next) => {
    // send a regular response
    res.send("regular");
  }
);

// handler for the /user/:id path, which sends a special response
app.get("/user/:id", (req, res, next) => {
  res.send("special");
});

异常处理

对于同步编程的中间件，当抛出一个异常时且没有自建异常处理函数时，Express 会自己来处理这个异常。Express 会根据错误的err.status (或err.statusCode)来设定状态码、错误信息等。我们也可以自己创建一个异常处理函数，如果为 Express 中间件传入四个参数，通常命名为(err, req, res, next)，则 Express 会把这一中间件当作异常处理函数。

app.get("/", (req, res) => {
  throw new Error("error occurs!"); // 异常由Express自建异常处理函数来处理
});

app.use((err, req, res, next) => {
  res.status(500).send("error occurs!"); // 或者可以自己编写异常处理函数
});

对于异步编程的中间件，要想进行异常处理，需要调用 next 函数并向其中传递一个值。如果中间件返回的是一个 Promise，则会自动调用 next(value)。下面的异步函数返回 Promise，如果中间抛出了异常或者 reject，则 Express 会默认调用 next 函数并传入异常信息。

app.get("/user/:id", async (req, res, next) => {
  var user = await getUserById(req.params.id);
  res.send(user);
});

更多时候，我们在中间件内部来处理异常，而不用将异常传递给 Express：

app.get("/", async (req, res) => {
    try{
    ...
    return res.status(200).send("ok");
    } catch(err) {
    ...
    return res.status(500).send("Internal Server Error");
    }
})

常用中间件

Express 提供了一些内建中间件供用户选择，比如常用的 express.json 会以 json 格式来解析请求体，express.urlencoded 会以 urlencoded 格式来解析请求体。还有一些第三方的中间件可以通过包管理器来安装，如 cookie-parser。

killsime
关注
Express框架:创建服务器和发布static资源
W2001r的博客
04-01 1607
总代码 import express from 'express';//导入 express const app = express() // 创建 web 服务器 // 监听客户端的 GET 和 POST 请求，并向客户端响应具体的内容 app.get('/', (req, res) => { var aa = { name: '张三', age: 20, gender: '男' } // 向客户端响应一个 JSON 对象 // 调用 express 提供的 res.sen
Node.js——一个简单的Express后端API开发
weixin_41309331的博客
07-14 971
Express是node.js的web开发框架,它有如下特点: unopinionated:框架本身只提供最小web应用开发API; 不限制应用设计模式(MVC,MVP); 不限制代码规范; 不限制功能的选择,例如是否有视图层生成HTML页面 Express实现简单的后端API开发 项目初始化 初始化项目 npm init -y # 初始化 npm add express # 添加express依赖 在根目录新建app.js const express = require('express
postman和express
最新发布
qq_60839348的博客
03-25 365
postman和express
Express框架（基础）
微光无限的博客
07-14 375
Express框架（基础）
EXPRESS项目PM2启动NODE_ENV传参数不生效问题解决方法
weixin_30492047的博客
07-05 888
expree项目开发完，涉及到不同环境，要在启动到时候就要配置好环境变量， packge.json文件如下： "scripts": { "dev": "NODE_ENV=development DEBUG=name nodemon ./bin/www --name 'name'", "start": "NODE_ENV=production pm2 start...
import express from 'express'; ^^^^^^^ SyntaxError: Unexpected identifier at Module._com
weixin_44087528的博客
07-19 4125
安装express时遇到这个问题，原因是express不支持ES6语法，需要安装babel 命令 npm install --save-dev babel-cli babel-preset-env 安装完之后创建 .babelrc 文件 创建完之后加入 { "presets" : ["env"] } 修改package.json文件 修改这一处 { "name": "...
JWT-nodejs:使用nodejs，express，Bcrypt和Postman的JWT登录身份验证
04-07
综上所述，这个项目涵盖了使用Node.js和Express构建Web服务、Bcrypt进行安全的密码管理以及利用JWT进行用户身份验证的核心技术。同时，Postman作为测试工具，帮助确保整个身份验证流程的正确性。这个项目对于学习和...
使用Express和JWT实现Postman持久化登录验证
8. **Postman模拟登录** 在Postman中发送POST请求到登录接口，获取返回的token。 9. **登录持久化验证** 客户端每次访问需要身份验证的接口时，需将token放入请求头。这可以通过前端自动完成，每次页面切换时检查...
短信验证2-Postman模拟前端发送数据
weixin_51029697的博客
03-24 349
1.index文件中写入 const express=require('express') const bodyParser=require('body-parser') //用于接收前端传来的数据 const request=require('request') //在后端请求接口 const querystring=require('querystring') const app=express();//实例化app用于监听 // parse application/x-www-form-ur.
如何使用 Postman 自动化 API 测试
分享身边生活经验blog
10-20 1004
API 是您作为开发人员构建的几乎每个应用程序的驱动力，充当两个或多个软件组件之间的通信渠道。但是，这种类型的系统的后果是一个组件的故障可能会对依赖它的其他组件产生重大影响。因此，广泛测试您的 API 以确保应用程序的正确性和可预测性至关重要。有许多不同的方法可以测试您的 API，您选择的任何方法或方法组合最终将取决于您当前的业务需求、可用资源和实施细节。在本文中，我们将探讨如何为将在 CI/CD 管道中运行的 API 编写自动化功能和集成测试。为什么要自动化 API 测试？
Web全栈开发学习笔记—Part4 测试 Express 服务端程序, 以及用户管理—b.测试后端应用
旭日东歌
01-07 484
目录 Test environment supertest Running tests one by one async/await async/await in the backend More tests and refactoring the backend Error handling and async/await Eliminating the try-catch Optimizing the beforeEach function Refactoring tests 现在
node用express写后端restful接口实战六：数据库的删改查：根据请求参数查询单篇文章、修改单篇文章、删除单篇文章、
*
10-20 474
这一节要来完成查看、修改、删除三个接口。这三个接口有一定的的相似性，再有了前面课程的基础后，相信咱们能顺利的搞定他们。 查询 先来做查看一篇文章的接口，打开数据库看看，所有的记录第一个字段，都是 id，而且这个 id 是自增的，永远不会重复的。如果想查询到一篇文章，最好的方法，就是使用这个唯一的 id 值来找到它。 router.get('/:id', async function (req, res, next) { res.json({id: req.params.id}); }); 那么我
超详细的node.js(Express框架)与本地数据建立连接，编写简单的接口
qq_51721168的博客
07-28 2950
用两种常用的方式，我们两种方法都来写一下。
【详细教程】教你如何使用Node + Express + Typescript开发一个应用
太空编程
01-25 4829
Express是nodejs开发中普遍使用的一个框架，下面要谈的是如何结合Typescript去使用。目标我们的目标是能够使用Typescript快速开发我们的应用程序，而最终我们的应用...
Express笔记
萝卜@兔子的专栏
09-18 1097
项目运行 cnpm run start(从package.json里面scripts项查找) notEmpty=true;代表url里面的参数是必选项 optional=true;代表可选 app.js的主要作用：附加中间件、请求参数校验、登录鉴权 cors 跨域资源共享是用来避开浏览器的同源策略，在处理app.get等请求之前使用 import cors from 'cors'; a
express框架在nodejs中的使用+解决跨域问题（cors三方库）
m0_62823653的博客
04-29 6459
第一部分commonJS使用第三方框架 一.托管静态资源（让用户直接访问静态资源） 例如，如上url分别是请求一张图片，一份样式文件，一份js代码。我们实现的web服务器需要能够直接返回这些文件的内容给客户端浏览器。 根目录 ├── public │├── css ││└── index.css │├── img ││└── bg.jpeg │├── js ││└── axios.js │└── index.html └── serve.j...
在express中使用ES7装饰器构建路由
Mengyu的博客
09-12 541
在express中使用ES7装饰器构建路由 在Java的Spring框架中，我们经常会看到类似于@Controller这样的注解，这类代码能够极大的提高我们代码的可读性和复用性。而在Javascript的ES7提案中，有一种新的语法叫做decorator，它能够在Javascript中实现与注解相同的功能。 @tuzilow/express-decorator @tuzilow/express-decorator是由本人开发的一个简单的express装饰器包，具有@Controller、@RootUrl、
Node.js之Express详解
热门推荐
WikY
11-11 1万+
Express Express 是基于 Node.js 平台，快速、开放、极简的 Web 开发框架 使用 Express，我们可以方便、快速的创建 Web 网站的服务器或 API 接口的服务器。 express的基本使用 安装 npm install express npm i express@最新版本号 创建基本的web服务器 导入express模块 创建web服务器 调用app.listen()函数启动服务器 //1.导入express模块 const express = require('ex
ES6，Typescripts，如何正确import express？
纠缠AI的亮子
11-26 2394
使用Typescripts，在导入模块时，常常出一些难以理解的简单错误。下面就给出标准答案，让你在 import 模块的时候不再迷惑。 1. 标准做法 import { Request, Response, Application } from 'express'; import express = require('express'); var app: Application = express(); app.get('/', function (req: Request, res: Respons
使用postman测试后端
07-28
你可以使用Postman来测试后端API。首先，确保你已经安装了Postman应用程序。然后，按照以下步骤进行测试： 1. 打开Postman应用程序。 2. 创建一个新的请求，点击左上角的'+'按钮。 3. 在请求的URL栏中输入你要测试...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值