用Node编写RESTful API接口的示例代码


Posted in Javascript onJuly 04, 2018

前言

本文介绍了如何用Node开发web程序,并通过一个todo list练习来介绍如何创建符合RESTful风格的API接口。

创建HTTP服务器

用Node创建HTTP服务器是非常方便的。

创建HTTP服务器要调用http.createServer()函数,它只有一个参数,是个回调函数,服务器每次收到HTTP请求后都会调用这个回调函数。这个回调会收到两个参数,请求和响应对象,通常简写为req和res:

var http = require('http')
var server = http.createServer(function(req, res){
  res.end('Hello World')
})
server.listen(3000, '127.0.0.1')

运行上面的代码,在浏览器中访问http://localhost:3000。然后你应该能看到一个包含“Hello World.”的普通文本页面。

服务器每收到一条HTTP请求,都会用新的req和res对象触发回调函数。

在触发回调函数之前,Node会解析请求的HTTP头,并将它们作为req对象的一部分提供给请求回调。但Node不会在回调函数被触发之前开始对请求体的解析。这种做法跟某些服务端框架不同,比如PHP就是在程序逻辑运行前就把请求头和请求体都解析出来了。

Node不会自动往客户端写任何响应。在调用完请求回调函数之后,就要由你负责用res.end()方法结束响应了(见下图)。这样在结束响应之前,你可以在请求的生命期内运行任何你想运行的异步逻辑。如果你没能结束响应,请求会挂起,直到客户端超时,或者它会一直处于打开状态。

用Node编写RESTful API接口的示例代码

搭建HTTP服务器仅仅是个开始。接下来我们来看看如何设定响应状态码和响应头中的字段,如何正确处理异常。

设置响应头

可以用res.setHeader(field, value)来设置相应的响应头,下面是代码:

var http = require('http')
var server = http.createServer(function(req, res){
 var body = '<h1>Hello Node</h1>'
 res.setHeader('Content-Length', body.length)
 res.setHeader('Content-Type', 'text/html')
 res.end(body)
})
server.listen(3000)

设置状态码

我们经常需要返回默认状态码200之外的HTTP状态码。比较常见的情况是当所请求的资源不存在时返回一个404 Not Found状态码。

这可以通过设定res.statusCode属性来实现。在程序响应期间可以随时给这个属性赋值,但必须在第一次调用res.write()或res.end()之前。

var http = require('http')
var server = http.createServer(function(req, res) {
 var body = '<p>页面丢失了</p>'
 res.setHeader('Content-Type', 'text/html;charset=utf-8')
 res.statusCode = 404
 res.end(body)
})
server.listen(3000, '127.0.0.1')

Node的策略是提供小而强的网络API,不同于Rails或Django之类的框架。像会话这种高级概念以及HTTP cookies这样的基础组件都没有包括在Node的内核之中。那些都要由第三方模块提供。

构建 RESTful Web 服务

Roy Fielding博士在2000年提出了表征状态转移 (REST)。它是一种基于 HTTP 协议的网络应用的接口风格。

依照规定,比如GET、POST、PUT和DELETE,分别与资源的获取、创建、更新和删除相对应。

HTTP 协议定义了以下8种标准的方法:

  1. GET:请求获取指定资源。
  2. HEAD:请求指定资源的响应头。
  3. POST:向指定资源提交数据。
  4. PUT:请求服务器存储一个资源。
  5. DELETE:请求服务器删除指定资源。
  6. TRACE:回显服务器收到的请求,主要用于测试或诊断。
  7. CONNECT:HTTP/1.1 协议中预留给能够将连接改为管道方式的代理服务器。
  8. OPTIONS:返回服务器支持的HTTP请求方法。

创建标准的REST服务需要实现四个HTTP谓词。每个谓词会覆盖一个操作:

  1. GET:获取
  2. POST:新增
  3. PUT:更新
  4. DELETE:删除

POST和GET请求

接下来,通过一个todo list练习来编写RESTful风格的GET和POST接口。

需求分析

项目采用前后端分离,交互数据格式约定为json,前端添加的数据提交到服务器后,由服务器存入服务器内存中。前端界面如下:

用Node编写RESTful API接口的示例代码

首先,我们先编写前端部分。

前端部分

前端采用vue.js作为框架,ajax请求采用axios库。代码如下:

<!DOCTYPE html>
<html lang="en">
<head>
 <meta charset="UTF-8">
 <title>Title</title>

 <script src="https://cdn.bootcss.com/vue/2.5.16/vue.js"></script>
 <script src="https://unpkg.com/axios/dist/axios.min.js"></script>
</head>

<body>

<div id="app">
 <h1>Todo List</h1>
 <ul>
  <li v-for="(item, index) in items" :key="index">{{ item }}</li>
 </ul>

 <input type="text" v-model="item">
 <button @click="postApi">button</button>
</div>

<script>
 new Vue({
  el: '#app',
  data: {
   items: [],
   item: ''
  },
  created () {
   axios.get('http://localhost:3000/')
    .then(response => {
     this.items = response.data
    })
    .catch(function (error) {
     console.log(error)
    })
  },
  methods: {
   postApi () {
    axios.post('http://localhost:3000/', {
     item: this.item
    })
     .then(response => {
      this.items = response.data
     })
     .catch(function (error) {
      console.log(error)
     })
   }
  }
 })
</script>
</body>
</html>

后端部分

var http = require('http')

var items = []

http.createServer(function(req, res) {
 // 设置cors跨域
 res.setHeader('Access-Control-Allow-Origin', '*')
 res.setHeader('Access-Control-Allow-Headers', 'Content-Type')
 res.setHeader('Content-Type', 'application/json')

 switch (req.method) {
  // 设置了cors跨域
  // post请求时,浏览器会先发一次options请求,如果请求通过,则继续发送正式的post请求
  case 'OPTIONS':
   res.statusCode = 200
   res.end()
   break

  case 'GET':
   let data = JSON.stringify(items)
   res.write(data)
   res.end()
   break

  case 'POST':
   let item = ''
   req.on('data', function (chunk) {
    item += chunk
   })
   req.on('end', function () {
    // 存入
    item = JSON.parse(item)
    items.push(item.item)
    // 返回到客户端
    let data = JSON.stringify(items)
    res.write(data)
    res.end()
   })
   break
 }
}).listen(3000)

console.log('http server is start...')

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
jQuery左右滚动支持图片放大缩略图图片轮播代码分享
Aug 26 Javascript
jQuery仿京东商城楼梯式导航定位菜单
Jul 25 Javascript
js实现漫天星星效果
Jan 19 Javascript
HTML中使背景图片自适应浏览器大小实例详解
Apr 06 Javascript
JavaScript30 一个月纯 JS 挑战中文指南(英文全集)
Jul 23 Javascript
在vue-cli中组件通信的方法
Dec 16 Javascript
详解js跨域请求的两种方式,支持post请求
May 05 Javascript
vue 路由嵌套高亮问题的解决方法
May 17 Javascript
在vue2.0中引用element-ui组件库的方法
Jun 21 Javascript
微信小程序 wepy框架与iview-weapp的用法详解
Apr 10 Javascript
vue框架制作购物车小球动画效果实例代码
Sep 26 Javascript
js实现网页随机验证码
Oct 19 Javascript
微信小程序踩坑记录之解决tabBar.list[3].selectedIconPath大小超过40kb
Jul 04 #Javascript
JS实现点击按钮可实现编辑功能
Jul 03 #Javascript
详解vue-cli中模拟数据的两种方法
Jul 03 #Javascript
echarts同一页面中四个图表切换的js数据交互方法示例
Jul 03 #Javascript
基于React+Redux的SSR实现方法
Jul 03 #Javascript
VUE 3D轮播图封装实现方法
Jul 03 #Javascript
vue.js轮播图组件使用方法详解
Jul 03 #Javascript
You might like
通俗易懂的php防注入代码
2010/04/07 PHP
如何使用php判断服务器是否是HTTPS连接
2013/07/05 PHP
php使用cookie保存登录用户名的方法
2015/01/26 PHP
php网页版聊天软件实现代码
2016/08/12 PHP
Laravel 实现关系模型取出需要的字段
2019/10/10 PHP
laravel框架的安装与路由实例分析
2019/10/11 PHP
学习ExtJS Column布局
2009/10/08 Javascript
jquery里的正则表达式说明
2011/08/03 Javascript
jQuery中创建实例与原型继承揭秘
2011/12/21 Javascript
JavaScript判断密码强度(自写代码)
2013/09/06 Javascript
js获取url参数值的两种方式
2013/09/10 Javascript
jQuery中:not选择器用法实例
2014/12/30 Javascript
深入探究JavaScript中for循环的效率问题及相关优化
2016/03/13 Javascript
Vue.js实现无限加载与分页功能开发
2016/11/03 Javascript
Angular.js中数组操作的方法教程
2017/07/31 Javascript
JavaScript实现图片切换效果
2017/08/12 Javascript
使用javaScript实现鼠标拖拽事件
2020/04/03 Javascript
记一次vue去除#问题处理经过小结
2019/01/24 Javascript
解决layer.confirm快速点击会重复触发事件的问题
2019/09/23 Javascript
在vue中把含有html标签转为html渲染页面的实例
2019/10/28 Javascript
解决React在安装antd之后出现的Can't resolve './locale'问题(推荐)
2020/05/03 Javascript
Vue时间轴 vue-light-timeline的用法说明
2020/10/29 Javascript
[01:10]DOTA2亚洲邀请赛 征战号角响彻全场
2015/01/06 DOTA
python下载图片实现方法(超简单)
2017/07/21 Python
解决Python print 输出文本显示 gbk 编码错误问题
2018/07/13 Python
通过python实现随机交换礼物程序详解
2019/07/10 Python
Python读取配置文件(config.ini)以及写入配置文件
2020/04/08 Python
Python unittest单元测试框架实现参数化
2020/04/29 Python
Python基于wordcloud及jieba实现中国地图词云图
2020/06/09 Python
基于注解实现 SpringBoot 接口防刷的方法
2021/03/02 Python
机电一体化大学生求职信
2013/11/08 职场文书
大专生的学习自我评价
2013/12/04 职场文书
住院医师规范化培训实施方案
2014/06/12 职场文书
学法用法心得体会(2016推荐篇)
2016/01/21 职场文书
2016年社会主义核心价值观心得体会
2016/01/21 职场文书
Apache Pulsar集群搭建部署详细过程
2022/02/12 Servers