当前位置: 首页 > news >正文

Node 10 接口

接口

简介

接口是什么

接口是 前后端通信的桥梁

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

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

这里的接口指的是『数据接口』, 与编程语言(Java,Go 等)中的接口语法不同

接口的作用

实现 前后端通信

image-20230327163353386

接口的开发与调用

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

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

接口的组成

一个接口一般由如下几个部分组成

  • 请求方法
  • 接口地址(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/ (英文)

http://www.lryc.cn/news/65312.html

相关文章:

  • 大型互联网企业大流量高并发电商领域核心项目已上线(完整流程+项目白皮书)
  • 汇编语言学习笔记六
  • 多商户商城系统-v2.2.3版本发布
  • 科研人必看入门攻略(收藏版)
  • 第5章 循环和关系表达式
  • Scalable Vector Graphics (SVG)中的svg、clipPath、mask元素
  • Java基础(十五)集合框架
  • 安装gitea
  • Java异常处理传递规范总结
  • 2d俯视视角游戏,可以切换多种枪械
  • 大四的告诫
  • 滚珠螺杆在设备上的应用
  • Day41线程同步
  • 设计模式之享元模式
  • 【GAMES101】05 Rasterization(Triangles)
  • 13. Pod 从入门到深入理解(二)
  • ORBBEC(奥比中光)AstraPro相机在ROS2下的标定与D2C(标定与配准)
  • 常量与变量:编程中重要的两种数据类型
  • ( 数组和矩阵) 287. 寻找重复数 ——【Leetcode每日一题】
  • 【学习笔记】「JOISC 2022 Day2」复制粘贴 3
  • 武忠祥老师每日一题||定积分基础训练(三)
  • Docker安装常用软件-Apollo(有问题)
  • f(x)与|f(x)|,f ‘ (x),F(x)常见关系。
  • 今天面了一个来字节要求月薪23K,明显感觉他背了很多面试题...
  • 如何使用二元三次回归分析建立预测模型?(分析、原理、代码示例)
  • 面向万物智联的应用框架的思考和探索(上)
  • 《Python机器学习基础教程》第1章学习笔记
  • ClickHouse 内存管理是如何实现的
  • docker容器技术
  • 设计模式七大设计原则