Node.js 入门 —— 使用 Express 编写接口

文章目录

1 前言

2 创建基本的服务器

const express = require('express')
const router = require('./apiRouter')

const app = express()
app.use(express.json())
app.use(express.urlencoded({
    
     extended: false }))
app.use('/api', router)

app.listen(80, () => {
    
    
  console.log('http://127.0.0.1');
})

3 编写接口

apiRouter.js

const express = require('express')
const router = express.Router()
// GET 请求
router.get('/get', (req, res) => {
    
    
  const query = req.query
  res.send({
    
    
    status: 0,
    message: 'GET 请求成功',
    data: query
  })
})
// POST 请求
router.post('/post', (req, res) => {
    
    
  const body = req.body
  res.send({
    
    
    status: 0,
    message: 'POST 请求成功',
    data: body
  })
})

module.exports = router

4 cors 资源跨域共享

4.1. 接口的跨域问题

解決接口跨域问题的方案主要有两种：

CORS （主流的解决方案，推荐使用）
JSONP（有缺陷的解决方案：只支持 GET 请求）

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

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

运行 npm install cors 安装中间件
使用 const cors = require(‘cors’) 导入中间件
在路由之前调用 app.use(cors()）配置中间件

4.3 什么是 CORS

CORS (Cross-Origin Resource Sharing，跨域资源共享）由一系列 HTTP 响应头组成，这些 HTTP 响应头决定浏览器是否阻止前端 JS 代码跨域获资源。
浏览器的同源安全策略默认会阻止网页"跨域”获取资源，但如果接口服务器配置了 CORS 相关的 HTTP 响应头，就可以解除浏览器端的跨域访问限制。

4.4 CORS 响应头

Access-Control-Allow-Origin: 允许访问该资源的URL

res.setHeader('Access-Control-Allow-Origin', 'http://www.baidu.com')
res.setHeader('Access-Control-Allow-Origin', '*')

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 对额外的请求头进行声明，否则这次请求会失败

res.setHeader('Access-Control-Allow-Headers', 'Request-Id')

Access-Control-Allow-Methods: 允许的 HTTP 方法

默认情况下，CORS 仅支持客户端发起 GET POST. HEAD 请求
如果客户端希望通过 PUT、 DELETE 等方式请求服务器的资源，则需要在服务器端，通过 Access-Control-Allow-Methods 来指明实际请求所允许使用的 HTTP 方法

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

4.5 简单请求

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

请求方式： 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)

4.6 预检请求

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

请求方式为 GET 、 POST 、 HEAD 之外的请求 Method 类型
请求头中包含自定义头部字段
向服务器发送了 application/json 格式的数据
在浏览器与服务器正式通信之前，浏览器会先发送 OPTION 请求进行预检，以获知服务器是否允许该实际请求，所以这一次的 OPTION 请求称为“预检请求”。服务器成功响应预检请求后，才会发送真正的请求，并且携带真实数据

5 jsonp 接口

5.1 JSONP 的概念与特点

概念：浏览器端通过<script＞标签的 src 属性，请求服务器上的数据，同时服务器返回一个函数的调用。这种请求数据的方式叫做 JSONP
特点：

JSONP 不属于真正的 Ajax 请求，因为它没有便用 XMLHttpRequest 这个对象
JSONP 仅支持 GET 请求，不支持 POST、PUT、DELETE 等请求

5.2 创建 JSONP 接口

如果项目中己经配置了 CORS 跨域资源共享，为了防止冲突．必须在配首 CORS 中间件之前声明 ISONP 的接口。否则
JSONP 接四会被处理成开启了 CORS 的接口

// 优先创建 JSONP 接口【这个接口不会被处理成 CORS 接口】
app.get('/api/jsonp', (req, res) => {
    
    })
// 再配置 CORS 中间件【后续的所有接口，都会坡处理成 CORS 接口】
const cors = require('cors')
app.use(cors())
// 这是一个开启了 CORS 的按口
app.get('/api/get', (req, res) => {
    
    })