Node 10 接口

news/2025/2/11 22:58:23/

接口

简介

接口是什么

接口是 前后端通信的桥梁

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

接口的英文单词是 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.ppmy.cn/news/58553.html

相关文章

Codefi基于区块链的开发框架

💗wei_shuo的个人主页 💫wei_shuo的学习社区 🌐Hello World ! Codefi基于区块链的开发框架 Codefi技术是一种基于区块链的开发框架,它提供了一系列工具和服务,帮助开发者轻松构建和管理去中心化应用程序。C…

Linux指令大全——从零入门到实用工具

如果你是一位Linux初学者,可能会被众多的Linux指令淹没在大海中,不知道该从何学起。本文就为你提供了绝对全面的Linux指令大全,涵盖了从入门到精通的各个领域,并附上了详细示范和趣味介绍,让你轻松学习,轻松…

解决:抠图时onnxruntime错误-无法加载“onnxruntime_providers_tensorrt.dll“-错误代码“126”

文章目录 (一)问题(二)假装分析(三)解决 (一)问题 在这篇:🔗《探索【Stable-Diffusion WEBUI】的附加功能:图片缩放&抠图》里面,…

Linux 基础语法 -2

如果我们以后再Linux当中 写了一些命名,导致程序我们不能进行操作了,如这个死循环: 他就会一直输出 "hello Linux" ,我们就使用 ctrl c 来终止因为程序或者指令异常,而导致我们无法进行指令输入&#xff…

魔兽服务端编译部署NPCBots和 Al机器人模块教程

魔兽服务端编译部署NPCBots和 Al机器人模块教程 大家好,我是艾西。在平时自己一个人玩魔兽的时候是不是会比较无聊,因为游戏机制或副本难度自己一个人无法进行快乐的玩耍。今天艾西教大家编译部署NPCBots和 Al机器人模块,直接一个人玩魔兽也不孤单 首先到GIT去下载ai机器…

Java时间类(一)-- SimpleDateFormat类

目录 1. SimpleDateFormat的构造方法: 时间模式字母: 2. SimpleDateFormat的常用方法: “工欲善其事,必先利其器”。学习时间类之前,需要先学习SimpleDateFormat类。 java.text.SimpleDateFormat类是以与语言环境有关的方式来格式

C++——迭代器

C中的迭代器是一种对象,可以用于遍历容器类型(如vector、list等)中的元素。它们的作用类似于指针,允许我们访问容器中的元素,从而实现对数据的迭代。C中有多种类型的迭代器,包括正向迭代器、反向迭代器、常…

阿里工作7年,肝到P8就剩这份学习笔记了,已助朋友拿到20个Offer

在阿里工作了7年,工作压力大,节奏快,但是从技术上确实得到了成长,尤其是当你维护与大促相关的系统的时候,熬到P7也费了不少心思,小编也是个爱学习的人,把这几年的工作经验整理成了一份完整的笔记…