fake-server

🚦Full fake REST APIs for frontend test 🏓 Powered by JSON Server 🚀🚀

Created with ❤️ for front-end developers who need a quick back-end for prototyping and mocking.

No setup required, available database and REST APIs on heroku.

All features powered by JSON Server

Database up to 200 users for testing.

Quickstart

• Clone or download the project
• Install NPM packages

npm install

• Generate your database if you want (optional)

npm run gen

• Start json-server (Please see package.json for more detail)

npm run start:dev
# or use `npm start`

Output:

➜ npm start
> json-server --watch db.json

  Resources
  http://localhost:3000/addresses
  http://localhost:3000/comments
  http://localhost:3000/companies
  http://localhost:3000/posts
  http://localhost:3000/profile
  http://localhost:3000/token
  http://localhost:3000/users

  Home
  http://localhost:3000

  Type s + enter at any time to create a snapshot of the database
  Watching...

Available APIs

Endpoints

Endpoints:

• Single documents: profile, token, login, signup, changePassword, logout, message
• Plural documents: users, posts, comments, companies, addresses

Examples:

Single documents:

• http://fakapi.herokuapp.com/login
• http://fakapi.herokuapp.com/signup
• http://fakapi.herokuapp.com/profile
• http://fakapi.herokuapp.com/token
• http://fakapi.herokuapp.com/changePassword
• http://fakapi.herokuapp.com/logout
• http://fakapi.herokuapp.com/message

Plural documents

• http://fakapi.herokuapp.com/users
• http://fakapi.herokuapp.com/posts
• http://fakapi.herokuapp.com/comments
• http://fakapi.herokuapp.com/companies
• http://fakapi.herokuapp.com/addresses

GET one

Examples:

• http://fakapi.herokuapp.com/users/1040
• http://fakapi.herokuapp.com/posts/2050

Filter

?[field]=[value]

Examples:

• http://fakapi.herokuapp.com/users?id=1040
• http://fakapi.herokuapp.com/users?status=true
• http://fakapi.herokuapp.com/users?address.country=Japan
• http://fakapi.herokuapp.com/users?address.country=Japan&status=true
• http://fakapi.herokuapp.com/posts?userId=1040

Paginate

_page, _limit

Examples:

• http://fakapi.herokuapp.com/posts?_page=3
• http://fakapi.herokuapp.com/posts?_page=3&limit=15

Sort

_order, _sort

Examples:

• http://fakapi.herokuapp.com/users?_sort=userName&&_order=asc
• http://fakapi.herokuapp.com/users?_sort=userName&&_order=asc&_page=5&limit=20
• http://fakapi.herokuapp.com/users?_sort=userName,id&_order=desc,asc
• http://fakapi.herokuapp.com/users?_sort=userName,id&_order=desc,asc&_page=1

Operators

_gte, _lte, _ne, _like

Examples:

• http://fakapi.herokuapp.com/posts?userId_lte=1040&userId_gte=1030
• http://fakapi.herokuapp.com/posts?userId_lte=1040&userId_gte=1030&_sort=userId
• http://fakapi.herokuapp.com/posts?userId_ne=1040&_sort=userId&_page=2
• http://fakapi.herokuapp.com/users?email_like=de
• http://fakapi.herokuapp.com/users?email_like=de&userName_like=de

Full-text search

?q=

Examples:

• http://fakapi.herokuapp.com/users?q=ala
• http://fakapi.herokuapp.com/posts?q=pro
• http://fakapi.herokuapp.com/companies?q=new

Relationship

_expand, _embed

• http://fakapi.herokuapp.com/posts?_expand=user&_limit=15&pages=1&q=Qui
• http://fakapi.herokuapp.com/posts?_embed=comments&_limit=15&pages=1&q=Qui

Donate