当前位置:   article > 正文

10、Node.js---API接口_nodejs api

nodejs api

目录

什么是接口

接口的作用

​编辑

接口的开发与调用

 接口的组成

 RESTful API

json-server  

 接口测试工具

 postman使用

记账本案例完善 


什么是接口

接口是 前后端通信的桥梁
简单理解:一个接口就是 服务中的一个路由规则 ,根据请求响应结果
接口的英文单词是 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),编写基本结构
例:
  1. {
  2. "song": [
  3. { "id": 1, "name": "干杯", "singer": "五月天" },
  4. { "id": 2, "name": "当", "singer": "动力火车" },
  5. { "id": 3, "name": "不能说的秘密", "singer": "周杰伦" }
  6. ]
  7. }
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测试

 

 获取单个账单

 

 更新账单接口

  1. //更新单个账单信息
  2. router.patch('/account/:id',(req,res)=>{
  3. //获取id参数
  4. let {id}=req.params;
  5. //查询数据库
  6. AccountModel.updateOne({_id:id},req.body,(err,data)=>{
  7. if(err){
  8. return res.json({
  9. code:'1005',
  10. msg:"更新失败",
  11. data:null
  12. })
  13. }
  14. //再次查询数据库 获取单条数据
  15. AccountModel.findById(id,(err,data)=>{
  16. if(err){
  17. return res.json({
  18. code:'1004',
  19. msg:"读取失败",
  20. data:null
  21. })
  22. }
  23. //成功响应
  24. res.json({
  25. code:'0000',
  26. msg:"更新成功",
  27. data:data
  28. })
  29. })
  30. })
  31. })

 postman测试

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/IT小白/article/detail/68995
推荐阅读
相关标签
  

闽ICP备14008679号