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

本文主要介绍日常开发、测试、教学或者分享中，可能遇到的模拟数据问题。分享免费开发的测试数据接口，以及如何利用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会有一些comment，albums会涉及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使用场景都可以用这两个方法来满足，快去试试吧！

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