使用Express写接口

Express写get接口

get无参数

const express = require('express');
const app = express();
app.get('/get', function(req, res) {
  // 直接返回对象
  res.json({ name: 'ceshi' });
});
app.listen('8088', () => {
  console.log('8088');
});

注意:
res.json()是express提供的方法,同时会结束请求(类似于res.end)

get接口有参数

express框架会自动收集get类型的接口从url地址中传递的查询字符串参数,并自动保存在req对象的query属性中,我们直接来获取即可.

const express = require('express');
const app = express();
app.get('/get', function(req, res) {
  // 直接返回对象
  //打印请求里的参数
  console.log(req.query);
  res.send({ name: 'abc' });
});
app.listen('8088', () => {
  console.log('8088');
});

注意: req.query属性是express框架额外提供的属性

post接口-普通键值

post接口与get请求不同在于: 它的参数一般是通过请求体来传递的,根据传递的参数的格式不同,分成三种情况来说
1.传递普通键值对
2.传递form表单(涉及文件上传)
3.传递json

普通键值对参数

具体来说当请求头的content-type为x-www-form-urlencoded时,表示上传的普通简单键值对.

// 1. 使用中间件
app.use(express.urlencoded());

app.post("/add",function(req,res){
// 2. 可以通过req.body来获取post传递的键值对	
// res.json是express提供的一个函数，用来返回一个json数据给客户端，同时会结束请求
// 类似于res.end, res.send()
    res.json(req.body)
})

注意:
● app.use(…)之后，在res.body中就会多出一个属性res.body。
● extended: false：表示使用系统模块querystring来处理传入的参数，也是官方推荐的
● extended: true：表示使用第三方模块qs来处理传入的参数.

post接口-json格式的参数

在post传递参数时，如果要传入的参数比较复杂（多级嵌套），则可以使用json格式上传。

var data = {
 name:"abc",
 address:{
     "a":1,
     "b":2,
     "info":"c"
 }
}

后端:

app.use(express.json());
// 会自动加入req.body属性，这个属性中就包含了post请求所传入的参数

// 用来处理JSON格式的数据
app.post('/postJSON',(req,res)=>{
    // 后端收到post传参
    console.log(req.body);
    
    res.send('/postJSON')
})

post接口-form-data文件上传

如果post涉及文件上传操作，则需要在服务器端额外使用第三方multer这个包（不属于express）来获取上传的信息。
Multer是一个node.js中间件,用于处理 multipart/form-data 类型的表单数据，它主要用于上传文件。
enctype=“multipart/form-data”

1.安装multer
npm install multer
2.使用

// 1. 引入包
const multer = require('multer');
// 2. 配置
const upload = multer({dest:'uploads/'}) // 上传的文件会保存在这个目录下
// uploads表示一个目录名，你也可以设置成其它的

// 3. 使用
// 这个路由使用第二个参数 .upload.single表示单文件上传， 'cover' 表示要上传的文件在本次上传数据中的键名。对应于前端页面上的：
//  <input type="file" name='cover'/>

app.post("/postfile",upload.single('cover'), function(req,res){
    // req.file 记录了文件上传的信息
    // req.body 记录了其它普通参数（非文件）的信息
	  // 其它操作
})

说明:
如果当前目录下没有uploads,它会自动创建uploads这个文件夹
upload.single只是处理了文件的上传。你仍可以通过req.body来获取其它参数

拓展介绍-RESTful接口

网络应用程序，分为前端和后端两个部分。当前的发展趋势，就是前端设备层出不穷（手机、平板、桌面电脑、其他专用设备…）。因此，必须有一种统一的机制，方便不同的前端设备与后端进行通信。这导致API构架的流行，甚至出现"APIFirst"的设计思想。RESTful API是目前比较成熟的一套互联网应用程序的API设计理论。

REST（Representational State Transfer）表述性状态转换，REST指的是一组架构约束条件和原则。 如果一个架构符合REST的约束条件和原则，我们就称它为RESTful架构。REST本身并没有创造新的技术、组件或服务，而隐藏在RESTful背后的理念就是使用Web的现有特征和能力， 更好地使用现有Web标准中的一些准则和约束。

符合REST规范的设计，我们称之为RESTful设计。 它的设计哲学是将服务器端提供的内容实体看作一个资源，并表现在url上。

普通接口设计

例如：
接口名：localhost:8080/getarticle
类型：get
功能：获取文章信息

接口名：localhost:8080/addarticle
类型：post
功能：添加新文章

接口名：localhost:8080/delarticle
类型：post
功能：删除文章

接口名：localhost:8080/updatearticle
类型：post
功能：编辑文章

RESTful接口设计

区别上述功能,主要依靠接口名称和请求类型而在restful设计中，它们应该是这样的：
接口名：localhost:8080/articles
类型：get
功能：获取文章信息

接口名：localhost:8080/articles
类型：post
功能：添加新文章

接口名：localhost:8080/articles
类型：delete
功能：删除文章

接口名：localhost:8080/articles
类型：put
功能：编辑文章

RESTful设计是：

● 通过URL设计资源。接口名一般都是名词，不包含动词。
● 请求方式（get,post,delete,put）决定资源的操作型