「工具|数据接口」免费公开的REST API & 如何借助github搭建自己的fake API接口

2023-09-14 10:47:02

本文主要介绍日常开发、测试、教学或者分享中,可能遇到的模拟数据问题。分享免费开发的测试数据接口,以及如何利用github快速搭建定制化的接口数据,避免使用真实数据的风险以及自己现编数据的麻烦。

一、场景说明

日常开发、测试、教学或者分享中,可能在使用需要请求数据的时候遇到一些困难:

  • 需要测试数据对处理逻辑进行测试
  • 进行前端开发时后端接口尚未开发
  • 教程或分享中不可以使用真实业务数据
  • 在一些对数据格式和内容没有要求的场景,手动编写数据进行mock比较麻烦

于是这就涉及到我们需要使用一些公开的且最好是免费的API来尽可能快速地满足我们这些需求场景。

接下来将介绍满足需求的jsonplaceholder,这个接口提供了一些场景类型以及内容的数据来供测试和设计原型时使用。

并且,我们会介绍,当我们对返回的数据和内容有定制化的需求的时候,同时又希望测试真实的网络请求时,如何借助GitHub和My JSON Server搭建一个返回我们预期数据的Fake API.


二、免费公开的Fake REST API: jsonplaceholder

JSONPlaceholder 是一个免费的在线 REST API,可以在我们需要一些虚假数据时使用。它可以位于 GitHub 上的自述文件中、CodeSandbox 上的演示、Stack Overflow 上的代码示例中,或者只是在本地进行测试。

JSONPlaceholder的API地址为: https://jsonplaceholder.typicode.com/,提供了6类常见的数据:

  • /posts: 100 posts
  • /comments: 500 comments
  • /albums: 100 albums
  • /photos: 5000 photos
  • /todos: 200 todos
  • /users: 10 users

同时提供的这些数据之间存在一些关联,比如post会有一些commentalbums会涉及photos等等。

接口支持所有的HTTP方法,遵循Restful风格,所以可以进行如下请求:

  • GET /posts
  • GET /posts/1
  • GET /posts/1/comments
  • GET /comments?postId=1
  • POST /posts
  • PUT /posts/1
  • PATCH /posts/1
  • DELETE /posts/1

更多使用案例可以参考官方文档


三、借助GitHub和My JSON Server搭建自己的定制化数据接口

如果我们希望返回的数据是定制化的,比如数据包含的字段由我们自己指定。那么可以借助GitHub和My JSON Server来快速Fake一个接口。方法如下:

  • 首先在github上面新建一个仓库 (/)
  • 在项目中新建一个db.json文件,这个文件里的数据就是我们的接口会返回的数据
  • 然后我们就可以访问https://my-json-server.typicode.com/<your-username>/<your-repo-name>来获取我们的数据了

比如官方的data.json内容如下:

{
  "posts": [
    {
      "id": 1,
      "title": "Post 1"
    },
    {
      "id": 2,
      "title": "Post 2"
    },
    {
      "id": 3,
      "title": "Post 3"
    }
  ],
  "comments": [
    {
      "id": 1,
      "body": "some comment",
      "postId": 1
    },
    {
      "id": 2,
      "body": "some comment",
      "postId": 1
    }
  ],
  "profile": {
    "name": "typicode"
  }
}

同时这个data.json在github上typicode用户的demo仓库下,那么我们就可以通过如下方式访问到对应数据:

  • 获取数据库全部数据:https://my-json-server.typicode.com/typicode/demo/db
  • 获取所有的post:https://my-json-server.typicode.com/typicode/demo/posts
  • 获取id为1的post:https://my-json-server.typicode.com/typicode/demo/posts/1

基本上常见的fake API使用场景都可以用这两个方法来满足,快去试试吧!

写文不易,如果对你有帮助的话,来一波点赞、收藏、关注吧~👇

更多推荐

PoE交换机出现不稳定的原因有哪些?

带有供电设备的PoE交换机给使用者带来了方便,因此被广泛应用。然而,很多使用商反映他们所使用的PoE交换机不稳定。那么,PoE交换机出现不稳定的原因有哪些?首先需要考虑的是数据传输的距离。尽管PoE供电交换机具有方便灵活的特点,但其供电距离不能超过100米。网线同时传输电力信号和数据信号,但电力信号的传输距离没有限制,

Python办公自动化之PDF

Python操作PDF1、Python操作PDF概述2、批量拆分3、批量合并4、内容提取(文字)5、提取内容(表格)6、提取图片7、PDF添加水印8、加密与解密1、Python操作PDF概述Python操作PDF主要有两个库:PyPDF2和pdfplumberPyPDF2是一个用于处理PDF文件的Python第三方库官

Unity的Resources类:从基础到高级的全面指南

前言Unity中的Resources类为开发者提供了一个方便的方式来加载和管理运行时资源。尽管它的使用简单直观,但为了充分发挥其潜力和避免常见的陷阱,还是需要对其有一些深入了解。Resources类简介Resources类是Unity中的一个静态类,它提供了方法来加载存储在特定“Resources”文件夹内的资源。这些

AI大模型服务应用场景

大模型是指模型具有庞大的参数规模和复杂程度的机器学习模型。在深度学习领域,大模型通常是指具有数百万到数十亿参数的神经网络模型。这些模型通常在各种领域,例如自然语言处理、图像识别和语音识别等,表现出高度准确和广泛的泛化能力。伴随基于大模型发展的各类应用的爆发,尤其是生成式AI,为用户提供突破性的创新机会,打破了创造和艺术

【爬虫实战】用python爬今日头条热榜TOP50榜单!

文章目录一、爬取目标二、爬取结果三、代码讲解四、技术总结五、演示视频六、附完整源码一、爬取目标您好!我是@马哥python说,一名10年程序猿。今天分享一期爬虫案例,爬取的目标是:今日头条热榜的榜单数据。打开今日头条首页,在页面右侧会看到头条热榜,如下:爬取以上6个关键字段,含:热榜排名,热榜标题,热度值,热榜标签,热

SpringCloud Gateway--网关服务基本介绍和基本原理

😀前言本篇博文是关于SpringCloudGateway的基本介绍,希望你能够喜欢🏠个人主页:晨犀主页🧑个人简介:大家好,我是晨犀,希望我的文章可以帮助到大家,您的满意是我的动力😉😉💕欢迎大家:这里是CSDN,我总结知识的地方,欢迎来到我的博客,感谢大家的观看🥰如果文章有什么需要改进的地方还请大佬不吝赐教

kafka

title:“Kafka”createTime:2022-01-05T11:35:47+08:00updateTime:2022-01-05T11:35:47+08:00draft:falseauthor:“name”tags:[“kafka”]categories:[“install”]description:“测试

【项目经验】:elementui表格中数字汉字排序问题及字符串方法localeCompare()

一.需求表格中数字汉字排序,数字按大小排列,汉字按拼音首字母(A-Z)排序。二.用到的方法第一步:把el-table-column上加上sortable="custom"<el-table-columnprop="date"label="序号"sortable="custom"width="180"></el-tabl

Vue入门简介(带你打开Vue的大门)

目录前言一、Vue简介1.什么是Vue2.Vue的应用场景3.Vue的作用(重要性)4.什么是MVVM模式5.开源库网址二、Vue入门使用1.基础使用步骤1.1引入Vue.js1.2创建Vue实例1.3编写Vue模板1.4数据绑定与指令1.5调用Vue方法和生命周期钩子2.Vue的优势2.1原生代码效果2.2Vue编写

2024届数字IC设计秋招面经-鼎信

背景985硕士,计算机科班,实验室做cpu设计和fpga算法加速,我做处理器安全方向,有项目。投递8.25没有笔试,两轮面试,直接通知下周一面试,草草的准备了下。一面技术面9.4不到半小时问项目和基础知识,当天出结果,第二天安排面试(不确实是技术还是HR)1.自我介绍2.挑一个熟悉的项目介绍下(AES加密算法)3.项目

岭回归与LASSO回归:解析两大经典线性回归方法

文章目录🍋引言🍋岭回归(RidgeRegression)🍋实战---岭回归🍋LASSO回归(LASSORegression)🍋实战---LASSO回归🍋岭回归和LASSO哪个更容易是直线🍋岭回归与LASSO回归的应用🍋L1正则化和L2正则化🍋偏差和方差🍋引言在机器学习和统计建模中,回归分析是一项重要

热文推荐