创建 RESTful

简介: 创建 RESTful

首先,创建一个 json 数据资源文件 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 显示用户详细信息

获取用户列表:

以下代码,我们创建了 RESTful API listUsers,用于读取用户的信息列表, server.js 文件代码如下所示:

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 server = app.listen(8081, function () {


 var host = server.address().address

 var port = server.address().port


 console.log("应用实例,访问地址为 http://%s:%s", host, port)


})

接下来执行以下命令:

$ node server.js

应用实例,访问地址为 http://0.0.0.0:8081

在浏览器中访问 http://127.0.0.1:8081/listUsers,结果如下所示:

{

  "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 addUser, 用于添加新的用户数据,server.js 文件代码如下所示:

var express = require('express');

var app = express();

var fs = require("fs");


//添加的新用户数据

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));

  });

})


var server = app.listen(8081, function () {


 var host = server.address().address

 var port = server.address().port

 console.log("应用实例,访问地址为 http://%s:%s", host, port)


})

接下来执行以下命令:

$ node server.js

应用实例,访问地址为 http://0.0.0.0:8081

在浏览器中访问 http://127.0.0.1:8081/addUser,结果如下所示:

{ 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 },

 user4:

  { name: 'mohit',

    password: 'password4',

    profession: 'teacher',

    id: 4 } 

}

显示用户详情

以下代码,我们创建了 RESTful API :id(用户id), 用于读取指定用户的详细信息,server.js 文件代码如下所示:

var express = require('express');

var app = express();

var fs = require("fs");


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 server = app.listen(8081, function () {


 var host = server.address().address

 var port = server.address().port

 console.log("应用实例,访问地址为 http://%s:%s", host, port)


})

接下来执行以下命令:

$ node server.js

应用实例,访问地址为 http://0.0.0.0:8081

在浏览器中访问 http://127.0.0.1:8081/2,结果如下所示:

{

  "name":"suresh",

  "password":"password2",

  "profession":"librarian",

  "id":2

}

删除用户

以下代码,我们创建了 RESTful API deleteUser, 用于删除指定用户的详细信息,以下实例中,用户 id 为 2,server.js 文件代码如下所示:

var express = require('express');

var app = express();

var fs = require("fs");


var id = 2;


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" + id];

     

      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)


})

接下来执行以下命令:

$ node server.js

应用实例,访问地址为 http://0.0.0.0:8081

在浏览器中访问 http://127.0.0.1:8081/deleteUser,结果如下所示:

{ user1:

  { name: 'mahesh',

    password: 'password1',

    profession: 'teacher',

    id: 1 },

 user3:

  { name: 'ramesh',

    password: 'password3',

    profession: 'clerk',

    id: 3 } 

}

目录
相关文章
|
5月前
|
存储 JSON 自然语言处理
ES Restful操作
ES Restful操作
|
2月前
|
XML JSON Java
什么是RESTful
RESTful是一种设计风格,用于规范HTTP接口的使用,旨在实现结构清晰、标准统一、易于理解和扩展的目标。在非RESTful模式下,同一资源的行为(如订单管理)可能会因人而异,导致请求方法(如POST与GET混用)和路径(如`/save/order`与`/save/product`)不一致,增加了维护难度。RESTful则强调资源的规范化,每个资源(如订单)都有唯一的URI,且通过标准的HTTP方法(GET、POST、PUT、DELETE等)来表示对该资源的不同操作。这种方式有助于确保接口的一致性和可预测性,简化了客户端和服务端的交互。
|
Kubernetes API 容器
k8s restful api 访问
restful api访问k8s集群,增删改查信息,做界面二次开发。需要预先创建访问权限的配置。 官网api文档https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.
10609 1
|
API 网络架构 开发者
RESTful 接口实现简明指南
在前后端分离的 Web 应用架构中,前端专注于页面,同时与后端进行数据交互;而后端则专注于提供 API 接口。在这样的结构下,REST 是一个很流行的前后端交互形式的约定。这只是一套约定,并不是某个技术标准,所以在实际的应用中,对器实现程度完全取决于后端开发者;一些号称 RESTful 的接口并没有那么RESTful。
3973 0
|
12月前
|
XML 存储 前端开发
Restful的详细介绍~
Restful的详细介绍~
|
12月前
|
JSON 缓存 数据格式
55SpringMVC - RESTful支持
55SpringMVC - RESTful支持
34 0
|
XML JSON 前端开发
Restful概念
Restful概念
90 0
|
XML JSON API
Restfule
+ 无状态 + 面向资源,即访问地址时使用的是名词形式 + 使用HTTP动词
|
JSON 缓存 API
6.2 Restful
讲解HTTP开发中Restful风格
|
Java 网络架构
RESTful的详解
RESTful 也称为REST(英文:Representational State Transfer)即表现层状态传递,它是一种软件架构风格或设计风格,而不是一个标准。
177 0
RESTful的详解