/Mocked-API

An API library of useful mocked endpoints to help you get your designs feeling lifelike with real data.

Primary LanguageTypeScriptMIT LicenseMIT

All Contributors

Mocked-API

About

Welcome to Mocked-API, this is a live API that can be accessed by anyone who needs data to test out their website, app, components etc.

Getting Started

First you should head over to https://api.mocked-api.dev and read our live api docs than start calling the api endpoints for the data you need.

Join our discord

Join Our Discord

How to run Mocked-API

Once you've cloned this repository, running Mocked-API is quite easy, there are just 2 steps you have to follow:

  1. Install the dependencies
npm install
  1. Serve the application
npm run serve

This will show you where the application is running

Mock API is running on port 3000.

Now you should be able to make any request to that port, and get a response back!

💡 If you browse to that port, you'll see our swagger documentation.

FAQ

Q: Are you planning to add more end points?
A: I plan to add as many as I can, if there is a specific endpoint of data you would like to see feel free to add a Issue Request.

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

I encourage you to contribute to Mocked-API! Feel free to fork the codebase and make a pull request for your changes.

Our contributing guide is currently WIP and available here CONTRIBUTING GUIDE

We use semantic commit messages

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

Sponsor

Do you like this project? Support it by donating.

Buy Me A Coffee

Contributors

Thanks goes to these wonderful people (emoji key):

Ahmed Silat
Ahmed Silat

💻
Yasio
Yasio

💻
Alberto Herrera Vargas
Alberto Herrera Vargas

📖
Coşkun Atak
Coşkun Atak

💻
Rizky ian indiarto
Rizky ian indiarto

💻
Evan
Evan

💻
Trigstur
Trigstur

💻
fadkeabhi
fadkeabhi

📖 💻
Thomas Martin
Thomas Martin

💻 ⚠️
Vu
Vu

💻 📖
Kalwabed Rizki
Kalwabed Rizki

💻 ⚠️
Talison Fabio
Talison Fabio

💻
Chris Jones
Chris Jones

🔧
jkol7
jkol7

💻
Siddharth Pandey
Siddharth Pandey

💻
Alex Harrison
Alex Harrison

💻
Derzan Chiang
Derzan Chiang

💻
ATH
ATH

📖
Suraj Bhandarkar S
Suraj Bhandarkar S

⚠️
Fernando Guerrero
Fernando Guerrero

📖 ⚠️
Anish De
Anish De

📖
Vaibhav Garje
Vaibhav Garje

💻 ⚠️
Mike Hingley
Mike Hingley

💻
Mayank Singh
Mayank Singh

📖

This project follows the all-contributors specification. Contributions of any kind welcome!