Node.js学习笔记(十七、RESTful API)

简介: Node.js学习笔记(十七、RESTful API)

REST

所谓REST,全称是Representational State Transfer,中文意思是表述性状态转移(通常译为表征。

 表述性状态转移是一组架构约束条件和原则。满足这些约束条件和原则的应用程序或设计就是RESTful。需要注意的是,REST是设计风格而不是标准。REST通常基于使用HTTP,URI,和XML(标准通用标记语言下的一个子集)以及HTML(标准通用标记语言下的一个应用)这些现有的广泛流行的协议和标准。REST  通常使用 JSON 数据格式。

RESTful风格架构特点

资源

所谓"资源",就是网络上的一个实体,或者说是网络上的一个具体信息。它可以是一段文本、一张图片、一首歌曲、一种服务,总之就是一个具体的实在。资源总要通过某种载体反应其内容,文本可以用txt格式表现,也可以用HTML格式、XML格式表现,甚至可以采用二进制格式;图片可以用JPG格式表现,也可以用PNG格式表现;JSON是现在最常用的资源表示格式。

统一接口

RESTful架构风格规定,数据的元操作,即CRUD(create, read,  update和delete,即数据的增删查改)操作,分别对应于HTTP方法:GET用来获取资源,POST用来新建资源(也可以用于更新资源),PUT用来更新资源,DELETE用来删除资源,这样就统一了数据操作的接口,仅通过HTTP方法,就可以完成对数据的所有增删查改工作。

即:

GET(SELECT):从服务器取出资源(一项或多项)。

POST(CREATE):在服务器新建一个资源。

PUT(UPDATE):在服务器更新资源(客户端提供完整资源数据)。

PATCH(UPDATE):在服务器更新资源(客户端提供需要修改的资源数据)。

DELETE(DELETE):从服务器删除资源。

URI

URI:统一资源定位符。

用于指向资源,即每个URI都对应一个特定的资源。要获取这个资源,访问它的URI就可以,因此URI就成了每一个资源的地址或识别符。

一般的,每个资源至少有一个URI与之对应,最典型的URI即URL。

无状态

所谓无状态的,即所有的资源,都可以通过URI定位,而且这个定位与其他资源无关,也不会因为其他资源的变化而改变。有状态和无状态的区别,举个简单的例子说明一下。如查询员工的工资,如果查询工资是需要登录系统,进入查询工资的页面,执行相关操作后,获取工资的多少,则这种情况是有状态的,因为查询工资的每一步操作都依赖于前一步操作,只要前置操作不成功,后续操作就无法执行;如果输入一个url即可得到指定员工的工资,则这种情况是无状态的,因为获取工资不依赖于其他资源或状态,且这种情况下,员工工资是一个资源,由一个url与之对应,可以通过HTTP中的GET方法得到资源,这是典型的RESTful风格。

创建 RESTful

首先创建一个users.json作为数据资源:

{
   "user1" : {
      "name" : "mahesh",
      "password" : "password1",
      "profession" : "teacher",
      "id": 1
   },
   "user2" : {
      "name" : "suresh",
      "password" : "password2",
      "profession" : "librarian",
      "id": 2
   },
   "user3" : {
      "name" : "ramesh",
      "password" : "password3",
      "profession" : "clerk",
      "id": 3
   }
}

增删改查的RESTful API如下:

序号 URI HTTP 方法 发送内容 结果
1 listUsers GET 显示所有用户列表
2 addUser POST JSON 字符串 添加新用户
3 deleteUser DELETE JSON 字符串 删除用户
4 :id GET 显示用户详细信息

创建restServre.js作为服务器,增删查的API都在里面。

var express = require('express');
var app = express();
var fs = require("fs");
//获取全部用户列表
app.get('/listUsers', function (req, res) {
   fs.readFile( __dirname + "/" + "users.json", 'utf8', function (err, data) {
       console.log( data );
       res.end( data );
   });
})
//添加的新用户数据
var user = {
   "user4" : {
      "name" : "mohit",
      "password" : "password4",
      "profession" : "teacher",
      "id": 4
   }
}
//添加用户
app.get('/addUser', function (req, res) {
   // 读取已存在的数据
   fs.readFile( __dirname + "/" + "users.json", 'utf8', function (err, data) {
       data = JSON.parse( data );
       data["user4"] = user["user4"];
       console.log( data );
       res.end( JSON.stringify(data));
   });
})
//根据id获取用户
app.get('/:id', function (req, res) {
   // 首先我们读取已存在的用户
   fs.readFile( __dirname + "/" + "users.json", 'utf8', function (err, data) {
       data = JSON.parse( data );
       var user = data["user" + req.params.id] 
       console.log( user );
       res.end( JSON.stringify(user));
   });
})
var id = 3;             //要删除用户id,尝试用url传递id,结果失败,回头再查查     
//根据id删除用户
app.get('/deleteUser', function (req, res) {
   // First read existing users.
   fs.readFile( __dirname + "/" + "users.json", 'utf8', function (err, data) {
       data = JSON.parse( data );
       delete data["user" + 3];
       console.log( data );
       res.end( JSON.stringify(data));
   });
})
var server = app.listen(8081, function () {
  var host = server.address().address
  var port = server.address().port
  console.log("应用实例,访问地址为 http://%s:%s", host, port)
})

运行:

image.png

查看全部用户,访问地址: http://127.0.0.1:8081/listUsers

image.png

添加用户,访问地址:http://127.0.0.1:8081/addUser

image.png

根据id查看用户,访问地址:http://127.0.0.1:8081/2

image.png

删除用户,访问地址:http://127.0.0.1:8081/deleteUser

image.png

.

参考:

【1】、https://www.runoob.com/nodejs/nodejs-restful-api.html

【2】、https://www.runoob.com/w3cnote/restful-architecture.html

【3】、https://blog.igevin.info/posts/restful-architecture-in-general/


目录
相关文章
|
7天前
|
JSON Java API
如何设计可扩展的RESTful API?
如何设计可扩展的RESTful API?
|
1天前
|
安全 前端开发 API
深入理解RESTful API设计原则与实践
【7月更文挑战第14天】在数字化时代的浪潮中,后端开发扮演着至关重要的角色,而RESTful API作为现代Web服务通信的基石,其设计质量直接影响到应用的性能与可维护性。本文将通过剖析RESTful API的核心设计原则,结合实际案例,探讨如何构建高效、易于理解和扩展的API。我们将从资源定位、请求方法、状态码使用等方面入手,揭示良好API设计的秘诀,并分享一些最佳实践和常见陷阱,旨在指导开发者打造更加健壮和友好的后端服务接口。
|
7天前
|
开发框架 监控 JavaScript
使用Node.js 框架( Express.js)来创建一个简单的 API 端点
【7月更文挑战第5天】使用Node.js 框架( Express.js)来创建一个简单的 API 端点
11 3
|
8天前
|
JSON Java API
如何设计可扩展的RESTful API?
如何设计可扩展的RESTful API?
|
3天前
|
XML 缓存 API
深入理解RESTful API设计原则与最佳实践
【7月更文挑战第12天】本文将探索RESTful API设计的核心原则和实用的最佳实践。我们将从REST的基本概念入手,逐步深入到API设计的高级话题,如版本控制、状态码的正确使用以及如何提高API的安全性。此外,我们还将探讨一些常见的设计挑战和解决方案,以帮助开发者构建更加健壮、可维护和用户友好的后端服务。
|
6天前
|
XML 前端开发 JavaScript
JavaScript进阶 - AJAX请求与Fetch API
【7月更文挑战第9天】JavaScript进阶:AJAX与Fetch API对比。AJAX用于异步数据交换,XMLHttpRequest API复杂,依赖回调。Fetch API是现代、基于Promise的解决方案,简化请求处理。示例:`fetch('url').then(r => r.json()).then(data => console.log(data)).catch(err => console.error(err))`。注意点包括检查HTTP状态、错误处理、CORS、Cookie和超时。Fetch提高了异步代码的可读性,但需留意潜在问题。
|
7天前
|
Java API 数据库
使用Spring Boot构建RESTful API
使用Spring Boot构建RESTful API
|
7天前
|
JavaScript Java 测试技术
基于springboot+vue.js+uniapp的云的学习笔记系统附带文章源码部署视频讲解等
基于springboot+vue.js+uniapp的云的学习笔记系统附带文章源码部署视频讲解等
10 0
|
前端开发 JavaScript API
【百度地图API】JS版本的常见问题
原文:【百度地图API】JS版本的常见问题 【新手必读】API常见问题   2011-12-12   1、请问如何将我的店铺标注在百度地图上?我是否可以做区域代理?在百度地图上标注是否免费?   答复: 这里只负责API的技术咨询,不解决任何地图标注问题。
2452 0
|
11天前
|
NoSQL 安全 API
如何有效提升 API 接口的安全性?
**API安全关键在于验证和防刷。通过排序参数、生成签名和MD5加密确保请求合法性。使用Redis限制请求频率,防止接口被恶意刷取。验证和防刷策略结合,保护API免受攻击和滥用。**
29 0