用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种标准的方法：
- GET：请求获取指定资源。
- HEAD：请求指定资源的响应头。
- POST：向指定资源提交数据。
- PUT：请求服务器存储一个资源。
- DELETE：请求服务器删除指定资源。
- TRACE：回显服务器收到的请求，主要用于测试或诊断。
- CONNECT：HTTP/1.1 协议中预留给能够将连接改为管道方式的代理服务器。
- OPTIONS：返回服务器支持的HTTP请求方法。
创建标准的REST服务需要实现四个HTTP谓词。每个谓词会覆盖一个操作：
- GET：获取
- POST：新增
- PUT：更新
- 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...')
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持我们。
相关推荐
-
flask-restful使用总结
Flask-RESTful是一个用于快速创建RESTful API接口的Flask扩展.使用Flask-RESTful可以很快速方便地创建一个RESTful风格的接口应用程序. 1.安装 pip install flask_restful 2.全部代码 from flask import Flask from flask_restful import reqparse, abort, Api, Resource app = Flask(__name__) api = Api(app) TODOS
-
angular6 填坑之sdk的方法
技术背景:angular + ant zorro 最为大型前端团队首选的前端技术框架,angular,在国内多少还是有些水土不服.本人将针对angular做个一系列的填坑分享. 坑一:sdk angular的sdk不属于各个模块,直接挂载在body下面, ant design直接使用sdk,导致任何的弹出层,如select,dropdown,picker等在弹出来的时候自动创建覆盖全局的sdk,需要点击sdk才能关闭已打开的下拉. 明显需要点击两次才能出现一个下拉是产品们不能接受的. 解决方案有
-
如何使用Spring RestTemplate访问restful服务
一. 什么是RestTemplate Spring's central class for synchronous client-side HTTP access. It simplifies communication with HTTP servers, and enforces RESTful principles. It handles HTTP connections, leaving application code to provide URLs(with possible tem
-
深入浅析Restful接口的两种使用方式
为什么用restful接口? 怎么用呢? restful接口常用的两种方式是get和post.下面简单介绍一下这两种方式的使用. 由于调用restful接口是通过url的方式来访问后端的代码.新建CustRegisterApi类以后,除了基本的注入外,还需要配置url的地址.以后的demo就在这个类里面写了. <strong><span style="font-size:18px;">@RestController @RequestMapping(value =
-
Yii2.0 RESTful API 基础配置教程详解
最近在做Yii2.0 RESTful API功能,找了好久的资料,才找到这类的教程,感谢该作者,以下内容根据我的项目实际情况做了一定的修改. 安装yii2.0 安装 Composer 后,您可以通过在 Web 可访问的文件夹下运行以下命令来 安装Yii应用程序模板: composer create-project --prefer-dist yiisoft/yii2-app-basic basic 初始化高级模板 cd advanced ./init 输入"./init"后会出现以下内
-
SpringBoot2.1 RESTful API项目脚手架（种子）项目
最近在做一个大型的J2EE项目,后端语言选择了Java,理所当然的选择了Spring,使用Spring MVC来做restful风格的api开发很是方便,Spring下面有很多子项目通过Springboot集成也很舒服.程序员都知道沟通很重要,实际项目中,往往是各自为战,尽管使用的是相同的框架.工具,编写的代码却千差万别,为了统一基础代码风格,编写了这个项目种子. 除此之外,在开发一个Web后端api项目时,通常都会经历搭建项目.选择依赖管理工具.引入基础包依赖.配置框架等,为了加快项目的开发进
-
Angular使用Restful的增删改
这篇来看一下如何进行增删改. 删除 使用delete进行删除,一般页面设计的时候也基本都是在列表页进行操作的.首先为删除的链接添加一个函数,因为一般删除都需要传入可定位删除的id或者name,前提是后端api是否支持,查看如下的调用之后,可以看到: 所以,只需要method使用delete,在传入的url中指定id或者name即可. 删除的restful调用:https://docs.konghq.com/0.13.x/admin-api/#delete-api 模版修改 html页面做如下修改
-
python用post访问restful服务接口的方法
具体代码如下: import requests import json data={"ids": ["00007190","00007191"]} url="http://XXXXX" data_json = json.dumps(data) headers = {'Content-type': 'application/json'} response = requests.post(url, data=data_json,
-
Angular(5.2->6.1)升级小结
在前面的文章中也曾经分别提到过,angular6由于存在一些稍大的变化,所以不能像Angular4到Angular5那样基本无感地进行升级,这里结合官方提示,简单整理一下Angular5.2到目前稳定的6.1的升级要点. 事前准备 变更内容 除此之外,还需要确认如下内容: tsconfig.json: preserveWhitespaces设定为off(v6缺省设定) package.json中scripts的使用,所有的cli命令统一使用两个横线–传入参数(POSIX规范) ngModelCh
-
Python利用Django如何写restful api接口详解
前言 用Python如何写一个接口呢,首先得要有数据,可以用我们在网站上爬的数据,在上一篇文章中写了如何用Python爬虫,有兴趣的可以看看://www.jb51.net/article/141661.htm 大量的数据保存到数据库比较方便.我用的pymsql,pymsql是Python中操作MySQL的模块,其使用方法和MySQLdb几乎相同.但目前在python3.x中,PyMySQL取代了MySQLdb. 1.连接数据库 # 连接数据库,需指定charset否则可能会报错 db = pym