脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 网络编程 → JavaScript → node.js → Node编写RESTful API接口

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

 更新时间：2018年07月04日 09:12:52   作者：moddx  
本篇文章主要介绍了用Node编写RESTful API接口的示例代码，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧

前言

本文介绍了如何用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()方法结束响应了（见下图）。这样在结束响应之前，你可以在请求的生命期内运行任何你想运行的异步逻辑。如果你没能结束响应，请求会挂起，直到客户端超时，或者它会一直处于打开状态。

搭建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，前端添加的数据提交到服务器后，由服务器存入服务器内存中。前端界面如下：

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

前端部分

前端采用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...')

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

相关文章

  • Nodejs学习笔记之Stream模块

    Nodejs学习笔记之Stream模块

    nodejs的fs模块并没有提供一个copy的方法，但我们可以很容易的实现一个，这种方式是把文件内容全部读入内存，然后再写入文件，对于小型的文本文件，这没有多大问题，比如grunt-file-copy就是这样实现的。
    2015-01-01
  • node基于express框架操作Mysql数据库的步骤

    node基于express框架操作Mysql数据库的步骤

    这篇文章主要介绍了node基于express框架操作Mysql数据库的步骤，文章给大家提到安装mysql模块和配置mysql模块的步骤，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2022-03-03
  • Nodejs进阶：express+session实现简易登录身份认证

    Nodejs进阶：express+session实现简易登录身份认证

    本篇文章主要介绍了Nodejs进阶：express+session实现简易身份认证示例，非常具有实用价值，需要的朋友可以参考下
    2017-04-04
  • node环境执行js文件的完整步骤

    node环境执行js文件的完整步骤

    Nodejs下运行JS代码有两种方式,一种是在Node.js的交互环境下运行,另外一种是把代码写入文件中,然后用node命令执行文件代码,下面这篇文章主要给大家介绍了关于node环境执行js文件的相关资料,需要的朋友可以参考下
    2023-02-02
  • Nodejs下使用gm圆形裁剪并合成图片的示例

    Nodejs下使用gm圆形裁剪并合成图片的示例

    本篇文章主要介绍了Nodejs下使用gm圆形裁剪并合成图片的示例，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
    2018-02-02
  • 利用yarn实现一个webpack+react种子

    利用yarn实现一个webpack+react种子

    其实以前就写过如何使用React-router和Webpack快速构建一个react程序。后来发现版本太老，于是乎最近又重新组织了下结构，使用最近发布的yarn作为包管理工具,介绍下基本安装步骤，有需要的朋友们下面来一起看看吧。
    2016-10-10
  • Node.js开发静态资源服务器

    Node.js开发静态资源服务器

    这篇文章主要为大家介绍了Node.js开发静态资源服务器示例详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2022-08-08
  • 深入浅析NodeJs并发异步的回调处理

    深入浅析NodeJs并发异步的回调处理

    这篇文章主要介绍了NodeJs并发异步的回调处理的相关资料,需要的朋友可以参考下
    2015-12-12
  • webstorm中配置nodejs环境及npm的实例

    webstorm中配置nodejs环境及npm的实例

    今天小编就为大家分享一篇webstorm中配置nodejs环境及npm的实例，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2018-05-05
  • node.js中的path.extname方法使用说明

    node.js中的path.extname方法使用说明

    这篇文章主要介绍了node.js中的path.extname方法使用说明,本文介绍了path.extname的方法说明、语法、使用实例和实现源码,需要的朋友可以参考下
    2014-12-12

最新评论