如何通过node.js来写接口详解

 更新时间:2022年09月09日 09:07:11   作者:stars满天繁星  
最近研究了一下nodejs写接口,发现接口并不难写,这篇文章主要给大家介绍了关于如何通过node.js来写接口的相关资料,文中通过实例代码和图文介绍的非常详细,需要的朋友可以参考下

前言

如果要通过node.js来写接口的话,首先我们需要借助一个框架--express,这个框架可以帮助我们快速的创建web服务器,所以我们需要通过npm下载这个包。

express写get接口

// 引入express
const express = require('express')
// 调用express()
const app = express()
 
// 设置请求对应的处理函数--当客户端以get方法请求,
//请求地址后面需要加/getbooks才能访问到响应后的数据
//app.get('/getbooks')相当于添加事件监听,当用户以get方法请求时,地址后面需要跟/getbooks,后面的回调函数才会执行
app.get('/getbooks', function (request, response) {
  let books = {
    "status": 200,
    "msg": "获取图书列表成功",
    "data": [
      {
        "id": 1,
        "bookname": "西游记",
        "author": "吴承恩",
        "publisher": "北京图书出版社"
      },
      {
        "id": 2,
        "bookname": "红楼梦",
        "author": "曹雪芹",
        "publisher": "上海图书出版社"
      },
      {
        "id": 3,
        "bookname": "三国演义",
        "author": "罗贯中",
        "publisher": "北京图书出版社"
      }
    ]
  }
//response.send是express框架提供的方法,相当于结束本次请求。
  response.send(books)
})
 
// 监听端口,启动web服务
app.listen(8000, function () {
  console.log('app listening on port 8000!')
})

通过localhost:8000/getbooks成为访问到数据。

此上,我们便简单的实现了一个get请求来获取到接口的数据。

express写post接口--键值对参数

当请求头中的content-type为x-www-form-urlencoded时,表示上传的为普通键值对参数

// 引入express
const express = require('express')
// 调用express()
const app = express()
 
// 使用中间件--请求的格式为普通键值对格式
app.use(express.urlencoded())
 
// 接口2--post普通键值对格式a=1&b=2
app.post('/addbooks', (request, response) => {
  //request.body发送的请求的参数
  console.log('请求返回', request.body)
  //response.send响应回来的参数
  response.send({ a: 1 })
})

因为这里我们是通过post请求传递参数的,所以这里我们不能继续向上面的get请求一样通过地址栏测试了,这里我会借助一个测试接口的工具来进行测试,用到的工具是--apifox。

这里我们直接发送请求,我们会向后端发送两个参数,下面是得到响应后的参数

我们去到小黑窗可以看见发送来的请求参数

express写post接口--json格式的参数

// 引入express
const express = require('express')
// 调用express()
const app = express()
 
// 会自动加入req.body属性,这个属性中就包含了post请求所传入的参数,格式为json格式
app.use(express.json())
 
// 接口3--post-json格式
app.post('/add-json', (request, response) => {
  console.log('请求返回', request.body)
  response.send({ "name": "xxx" })
})

这里我们依旧会加入一个中间件来得到请求的参数。

测试接口

express写post接口--form-data文件上传

// 引入express
const express = require('express')
// 调用express()
const app = express()
 
// 引入包
const multer = require('multer');
// 配置
// uploads表示一个目录名,你也可以设置成其它的
const upload = multer({ dest: 'uploads/' }) // 上传的文件会保存在这个目录下
 
// 接口4--通过post请求进行文件的上传
app.post('/add-file', upload.single('img'), (request, response) => {
  console.log(request.body)
  console.log(request.file)
  response.send({ name: "小红" })
})

测试接口

响应的参数

总结 

到此这篇关于如何通过node.js来写接口的文章就介绍到这了,更多相关node.js写接口内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • koa-compose简单实现及使用的妙处

    koa-compose简单实现及使用的妙处

    这篇文章主要为大家介绍了koa-compose简单实现及使用的妙处详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-04-04
  • 基于Node.js实现nodemailer邮件发送

    基于Node.js实现nodemailer邮件发送

    Nodemailer 是一个简单易用的 Node.JS 邮件发送模块(通过 SMTP,sendmail,或者 Amazon SES),支持 unicode,你可以使用任何你喜欢的字符集。Nodemailer是一个简单易用的Node.js邮件发送组件,需要的朋友可以参考下
    2016-01-01
  • node.js降低版本的方式详解(解决sass和node.js冲突问题)

    node.js降低版本的方式详解(解决sass和node.js冲突问题)

    这篇文章主要介绍了node.js降低版本的方式(解决sass和node.js冲突),本文是因为sass版本和node版本不匹配(可以找一下对应的版本),本文给大家详细讲解,需要的朋友可以参考下
    2023-02-02
  • nodejs部署到腾讯云服务器的实现(宝塔面板linux系统)

    nodejs部署到腾讯云服务器的实现(宝塔面板linux系统)

    本文主要介绍了nodejs部署到腾讯云服务器的实现(宝塔面板linux系统),文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-06-06
  • node强缓存和协商缓存实战示例

    node强缓存和协商缓存实战示例

    这篇文章主要为大家介绍了node强缓存和协商缓存实战示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-07-07
  • node前端开发模板引擎Jade的入门

    node前端开发模板引擎Jade的入门

    这篇文章主要介绍了node前端开发模板引擎Jade的入门,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-05-05
  • 参考 EventEmitter实现一个简单的订阅发布功能函数

    参考 EventEmitter实现一个简单的订阅发布功能函数

    这篇文章主要为大家介绍了参考 EventEmitter实现一个简单的订阅发布功能函数示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-02-02
  • node.js中使用node-schedule实现定时任务实例

    node.js中使用node-schedule实现定时任务实例

    这篇文章主要介绍了node.js中使用node-schedule实现定时任务实例,包括安装方法和4种使用例子,需要的朋友可以参考下
    2014-06-06
  • 教你快速搭建Node.Js服务器的方法教程

    教你快速搭建Node.Js服务器的方法教程

    Node.js是一套用来编写高性能网络服务器的JavaScript工具包,一系列的变化由此开始。这篇文章主要给大家介绍了如何快速搭建Node.Js服务器的方法教程,文中介绍的非常详细,对大家具有一定的参考价值,需要的朋友下面来一起看看吧。
    2017-03-03
  • 从零开始学习Node.js系列教程之SQLite3和MongoDB用法分析

    从零开始学习Node.js系列教程之SQLite3和MongoDB用法分析

    这篇文章主要介绍了Node.js SQLite3和MongoDB用法,结合实例形式分析了SQLite3和MongoDB数据库的初始化、连接、查询等操作的实现技巧与相关注意事项,需要的朋友可以参考下
    2017-04-04

最新评论