10、Node.js---API接口

新新程序名媛

已于 2023-05-03 12:18:53 修改

阅读量639

点赞数

分类专栏： Node.js 文章标签： node.js restful 后端

于 2023-04-26 23:56:05 首次发布

本文链接：https://blog.csdn.net/ezzbb/article/details/130374960

版权

Node.js 专栏收录该内容

12 篇文章 1 订阅

订阅专栏

文章介绍了接口作为前后端交互桥梁的角色，详细阐述了RESTfulAPI的设计原则，并通过json-server演示了如何快速搭建API服务。同时，讨论了接口测试工具Postman的使用，并提供了一个记账本案例来展示接口的增删改查操作。

摘要由CSDN通过智能技术生成

什么是接口

接口是前后端通信的桥梁

简单理解：一个接口就是服务中的一个路由规则，根据请求响应结果

接口的英文单词是 API (Application Program Interface) ，所以有时也称之为 API 接口

这里的接口指的是『数据接口』，与编程语言（ Java ， Go 等）中的接口语法不同

接口的作用

实现前后端通信

接口的开发与调用

大多数接口都是由后端工程师开发的，开发语言不限

一般情况下接口都是由前端工程师调用的，但有时后端工程师也会调用接口，比如短信接口，支付接口等

接口的组成

请求方法
接口地址（URL）
请求参数
响应结果

一个接口示例 https://www.free-api.com/doc/325

示例：https://api.asilu.com/idcard/?id=371522199111299668

RESTful API

RESTful API 是一种特殊风格的接口，主要特点有如下几个：

URL 中的路径表示资源，路径中不能有动词，例如 create , delete , update 等这些都不能有
操作资源要与 HTTP 请求方法对应
操作结果要与 HTTP 响应状态码对应

规则示例：

操作	请求类型	URL	返回
新增歌曲	POST	/song	返回新生成的歌曲信息
删除歌曲	DELETE	/song/10	返回一个空文档
全局修改歌曲	PUT	/song/10	返回更新后的歌曲信息
局部修改歌曲	PATCH	/song/10	返回更新后的歌曲信息
获取所有歌曲	GET	/song	返回歌曲列表数组
获取单个歌曲	GET	/song/10	返回单个歌曲信息

扩展阅读：https://www.ruanyifeng.com/blog/2014/05/restful_api.html

json-server

json-server 本身是一个 JS 编写的工具包，可以快速搭建 RESTful API 服务

官方地址 : https://github.com/typicode/json-server

操作步骤：

1. 全局安装 json - server

npm i -g json-server

2、创建 JSON 文件（db.json），编写基本结构

例：

{
    "song": [
    { "id": 1, "name": "干杯", "singer": "五月天" },
    { "id": 2, "name": "当", "singer": "动力火车" },
    { "id": 3, "name": "不能说的秘密", "singer": "周杰伦" }
    ]
}

3、以 JSON 文件所在文件夹作为工作目录，执行如下命令

json-server --watch db.json

默认监听端口为 3000

接口测试工具

apipost https://www.apipost.cn/ (中文)
apifox https://www.apifox.cn/ (中文)
postman https://www.postman.com/ (英文)

apipost使用

postman使用

=======================================================================

记账本案例完善

结合API接口

新建一个web文件夹，把index放入web里面

app.js代码新增

应该返回JSON格式数据，下面进行修改

获取账单接口

api/account.js代码

postman测试api

添加账单接口

api/account.js 新增数据代码

postman测试

插入成功

插入失败

删除账单接口

api/account.js 新增数据代码

postman测试

获取单个账单

更新账单接口

//更新单个账单信息
 router.patch('/account/:id',(req,res)=>{
     //获取id参数
     let {id}=req.params;
     //查询数据库
     AccountModel.updateOne({_id:id},req.body,(err,data)=>{
         if(err){
             return res.json({
                 code:'1005',
                 msg:"更新失败",
                 data:null
             })
         }
         //再次查询数据库 获取单条数据
         AccountModel.findById(id,(err,data)=>{
            if(err){
                return res.json({
                    code:'1004',
                    msg:"读取失败",
                    data:null
                })
            }
         //成功响应
         res.json({
             code:'0000',
             msg:"更新成功",
             data:data
         })
     })
 })
})

postman测试