使用Express写接口

简介: 使用Express写接口

使用Express 写接口


创建基本的服务器


const express = require('express')
const app = express()
app.listen(8080, () => {
    console.log('Express server running at http://127.0.0.1');
})


创建API路由模块


const express = require('express')
const router = express.Router()
// bind your router here ...
module.exports = router


编写GET接口


router.get('/get', (req, res) => {
    // 获取客户端通过查询字符串,发送到服务器的数据
    const query = req.query
    // 调用 res.send() 方法,把数据响应给客户端
    res.send({
        status: 200, // 状态 200 表示成功过
        msg: 'GET请求成功',
        data: query
    })
})


编写POST接口


router.post('/post', (req, res) => {
    // 获取客户端通过请求体,发送到服务器的URL-encoded数据
    const body = req.body
    // 调用 res.send() 方法,把数据响应给客户端
    res.send({
        status: 200, // 状态 200 表示成功过
        msg: 'GET请求成功',
        data: body
    })
})

注意:如果要获取 URL-encoded 格式的请求体数据,必须配置中间件 app.use(express.urlencoded({ extended: false }))


CORS 跨域资源共享


接口的跨域问题

刚才编写的 GET 和 POST接口,存在一个很严重的问题:不支持跨域请求。 解决接口跨域问题的方案主要有两种:

① CORS(主流的解决方案,推荐使用)

② JSONP(有缺陷的解决方案:只支持 GET 请求)

使用 cors 中间件解决跨域问题

cors 是 Express 的一个第三方中间件。通过安装和配置 cors 中间件,可以很方便地解决跨域问题。 使用步骤分为如下 3 步:

① 运行 npm install cors 安装中间件

② 使用 const cors = require('cors') 导入中间件

③ 在路由之前调用 app.use(cors()) 配置中间件

什么是 CORS

CORS (Cross-Origin Resource Sharing,跨域资源共享)由一系列 HTTP 响应头组成,这些 HTTP 响应头决定 浏览器是否阻止前端 JS 代码跨域获取资源。

浏览器的同源安全策略默认会阻止网页“跨域”获取资源。但如果接口服务器配置了 CORS 相关的 HTTP 响应头, 就可以解除浏览器端的跨域访问限制。

1670071990189.jpg

CORS 的注意事项

① CORS 主要在服务器端进行配置。客户端浏览器无须做任何额外的配置,即可请求开启了 CORS 的接口。

② CORS 在浏览器中有兼容性。只有支持 XMLHttpRequest Level2 的浏览器,才能正常访问开启了 CORS 的服 务端接口(例如:IE10+、Chrome4+、FireFox3.5+)。

CORS 响应头部 - Access-Control-Allow-Origin

响应头部中可以携带一个 Access-Control-Allow-Origin 字段,其语法如下:

Access-Control-Allow-Origin: <origin> | *

其中,origin 参数的值指定了允许访问该资源的外域 URL。

例如,下面的字段值将只允许来自 itcast.cn 的请求:

res.setHeader('Access-Control-Allow-Origin', 'http://itcast.cn')

如果指定了 Access-Control-Allow-Origin 字段的值为通配符 *,表示允许来自任何域的请求,示例代码如下:

res.setHeader('Access-Control-Allow-Origin', '*')

CORS 响应头部 - Access-Control-Allow-Headers

默认情况下,CORS 仅支持客户端向服务器发送如下的 9 个请求头:

Accept、Accept-Language、Content-Language、DPR、Downlink、Save-Data、Viewport-Width、Width 、 Content-Type (值仅限于 text/plain、multipart/form-data、application/x-www-form-urlencoded 三者之一)

如果客户端向服务器发送了额外的请求头信息,则需要在服务器端,通过 Access-Control-Allow-Headers 对额外 的请求头进行声明,否则这次请求会失败!

// 允许客户端额外向服务器发送 Content-Type 请求头和 X-Custom-Header 请求头
// 注意:多个请求体之间使用英文的逗号进行分割
res.setHeader('Access-Control-Allow-Headers', 'Content-Type, X-Custom-Header')

CORS 响应头部 - Access-Control-Allow-Methods

默认情况下,CORS 仅支持客户端发起 GET、POST、HEAD 请求。

如果客户端希望通过 PUT、DELETE 等方式请求服务器的资源,则需要在服务器端,通过 Access-Control-Alow-Methods 来指明实际请求所允许使用的 HTTP 方法。

示例代码如下:

// 只允许 POST, GET, DELETE, HEAD 请求方法
res.setHeader('Access-Control-Allow-Methods', 'POST, GET, DELETE, HEAD')
// 允许所有的HTTP请求方法
res.setHeader('Access-Control-Allow-Methods', '*')

CORS请求的分类

客户端在请求 CORS 接口时,根据请求方式和请求头的不同,可以将 CORS 的请求分为两大类,分别是:

① 简单请求

② 预检请求

简单请求

同时满足以下两大条件的请求,就属于简单请求:

① 请求方式:GET、POST、HEAD 三者之一

② HTTP 头部信息不超过以下几种字段:无自定义头部字段、Accept、Accept-Language、Content-Language、DPR、 Downlink、Save-Data、Viewport-Width、Width 、Content-Type(只有三个值application/x-www-form-urlencoded、multipart/form-data、text/plain)

预检请求

只要符合以下任何一个条件的请求,都需要进行预检请求:

① 请求方式为 GET、POST、HEAD 之外的请求 Method 类型

② 请求头中包含自定义头部字段

③ 向服务器发送了 application/json 格式的数据

在浏览器与服务器正式通信之前,浏览器会先发送 OPTION 请求进行预检,以获知服务器是否允许该实际请求,所以这一 次的 OPTION 请求称为“预检请求”。服务器成功响应预检请求后,才会发送真正的请求,并且携带真实数据。

简单请求和预检请求的区别

简单请求的特点:客户端与服务器之间只会发生一次请求。

预检请求的特点:客户端与服务器之间会发生两次请求,OPTION 预检请求成功之后,才会发起真正的请求。

相关文章
|
3月前
|
JavaScript 前端开发 中间件
Node.js—Express使用、Express 路由 、Express 中间件、托管静态资源、使用 Express 写接口、node.js链接sqlite数据库
Node.js—Express使用、Express 路由 、Express 中间件、托管静态资源、使用 Express 写接口、node.js链接sqlite数据库
108 0
mongoose + express写自查寻接口时,以递归格式多级查询或aggregate查询
mongoose + express写自查寻接口时,以递归格式多级查询或aggregate查询
|
4月前
|
中间件
使用 Express 框架开发数据爬取及展示接口
使用 Express 框架开发数据爬取及展示接口
41 0
|
8月前
|
JavaScript 中间件 API
使用Express写接口
使用Express写接口
72 0
|
8月前
|
JavaScript API
Node.js学习笔记----使用express编写接口
Node.js学习笔记----使用express编写接口
|
JSON 前端开发 JavaScript
【node进阶】深度解析express框架---编写接口|解决跨域问题---下篇
【node进阶】深度解析express框架---编写接口|解决跨域问题---下篇
【node进阶】深度解析express框架---编写接口|解决跨域问题---下篇
|
安全 JavaScript 前端开发
【node进阶】深度解析express框架---编写接口|解决跨域问题---上篇
【node进阶】深度解析express框架---编写接口|解决跨域问题---上篇
|
JSON 开发框架 JavaScript
Node.js之Express、路由、中间件、接口跨域解决方案详解(附实例)
本文主要介绍了Node.js中Express、路由、中间件、接口跨域解决方案
680 1
Node.js之Express、路由、中间件、接口跨域解决方案详解(附实例)
|
前端开发
express搭建后端请求路由,前端进行访问对应的接口 后端解决跨域
express搭建后端请求路由,前端进行访问对应的接口 后端解决跨域
|
3月前
|
JSON JavaScript 前端开发
超级实用!详解Node.js中的util模块和express模块
超级实用!详解Node.js中的util模块和express模块