Giter Club home page Giter Club logo

mocked-api's Introduction

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.

Sponsors

We are eternally greatful for the amazing sponsors of this project. They help provide this little birdy with a home to live in. So thank you to the following sponsors for their contributions to the platform.

If you would like to help support this project. We now have an Open Collective page which you can visit here

cweave cweave

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. Configure the application An example configuration file .env.example is provided.
npm run config
  1. Serve the application
npm run serve

This will show you where the application is running

Mock API is running on port 3000.

Getting Started (Docker)

  1. Ensure you have Docker installed
  2. Open your terminal/command line tool
  3. Run docker-compose up
  4. Open your browser to http://localhost: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

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

๐Ÿ’ป โš ๏ธ
Mayank Singh
Mayank Singh

๐Ÿ“–
Mike Hingley
Mike Hingley

๐Ÿ’ป
krishna
krishna

๐Ÿ’ป
Vadym Yatsyuk
Vadym Yatsyuk

๐Ÿ“–
Nicholas Robert Beckham
Nicholas Robert Beckham

โš ๏ธ
Ayanwola Ayomide
Ayanwola Ayomide

๐Ÿ’ป โš ๏ธ ๐Ÿ“–
Zuhaib Shah
Zuhaib Shah

๐Ÿ’ป
Guilherme Fernandes
Guilherme Fernandes

๐Ÿ’ป
Ben Halverson
Ben Halverson

๐Ÿ’ป โš ๏ธ
Ayush Chauhan
Ayush Chauhan

โš ๏ธ ๐Ÿ’ป
Edwards Moses
Edwards Moses

๐Ÿ“– โš ๏ธ
Rajitha Gunathilake
Rajitha Gunathilake

๐Ÿ’ป
Bram Musuko Panjaitan
Bram Musuko Panjaitan

โš ๏ธ
filip
filip

๐Ÿ’ป
Farhaan
Farhaan

๐Ÿ’ป
lauk20
lauk20

๐Ÿ’ป
Sherly Febrianti
Sherly Febrianti

๐Ÿ“–
headStyleColorRed
headStyleColorRed

๐Ÿ’ป
mdmuaj13
mdmuaj13

๐Ÿ’ป
Christopher Vestman
Christopher Vestman

๐Ÿ’ป
Ava Elise
Ava Elise

๐Ÿ’ป
Janet Thieu
Janet Thieu

๐Ÿ’ป
Vishwa Mahadevan
Vishwa Mahadevan

๐Ÿ’ป
Christa
Christa

๐Ÿ“–
Bruno Vilar
Bruno Vilar

๐Ÿ“–
Vitor
Vitor

๐Ÿ’ป
Palaniappan
Palaniappan

๐Ÿ’ป
Suppergerrie2
Suppergerrie2

๐Ÿ’ป
Dipendra Shrestha
Dipendra Shrestha

๐Ÿ’ป
Elijah Soladoye
Elijah Soladoye

๐Ÿ’ป ๐Ÿ“–

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

mocked-api's People

Contributors

ade1705 avatar ageddesi avatar alexjharrison avatar allcontributors[bot] avatar anishde12020 avatar benhalverson avatar computamike avatar devrrior avatar devvspaces avatar edwardsmoses avatar eroxl avatar fadkeabhi avatar filipkujawa avatar guilhermefernandes01 avatar headstylecolorred avatar kalwabed avatar lauk20 avatar mito0o avatar mohdmulla avatar renovate[bot] avatar sherlyfebrianti96 avatar shodown96 avatar talis-fb avatar thom-asm avatar timothee-durand avatar utsav00 avatar vishalkhoje avatar vtv6 avatar yasionfire avatar zaibugemi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

mocked-api's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

Detected dependencies

docker-compose
docker-compose.yml
dockerfile
Dockerfile
  • node 19-alpine
github-actions
.github/workflows/codesee-arch-diagram.yml
  • Codesee-io/codesee-action v2
.github/workflows/pr.yml
  • actions/checkout v3
  • actions/setup-node v3
npm
package.json
  • @sentry/node ^7.17.4
  • @sentry/tracing ^7.17.4
  • chucknorris-io ^1.0.5
  • cors ^2.8.5
  • dotenv ^16.0.2
  • express ^4.18.1
  • express-rate-limit ^6.6.0
  • morgan ^1.10.0
  • slugify ^1.6.5
  • supertest ^6.2.4
  • swagger-jsdoc ^6.2.5
  • swagger-ui-express ^4.5.0
  • @faker-js/faker 7.6.0
  • @types/express 4.17.17
  • @types/jest 29.2.3
  • @types/node 18.11.9
  • @types/supertest 2.0.12
  • @types/swagger-jsdoc 6.0.1
  • @types/swagger-ui-express 4.1.3
  • @typescript-eslint/eslint-plugin 5.44.0
  • all-contributors-cli 6.24.0
  • eslint 8.28.0
  • eslint-config-prettier ^8.5.0
  • eslint-config-standard-with-typescript 34.0.0
  • eslint-plugin-import ^2.26.0
  • eslint-plugin-n 15.5.1
  • eslint-plugin-prettier ^4.2.1
  • eslint-plugin-promise 6.1.1
  • nodemon 2.0.20
  • prettier 2.8.3
  • ts-jest 29.0.5
  • ts-node 10.9.1
  • typescript 4.9.5
  • jest 29.3.1
  • typescript-eslint ^0.0.1-alpha.0
  • fsevents ~2.3.2

  • Check this box to trigger a request for Renovate to run again on this repository

Improve Chat Message endpoints to include the users

Is your feature request related to a problem? Please describe.
When you get the current list of messages back, we can not display a user friendly name or even a user profile image as we do not send back the list of users that we have generated.

Describe the solution you'd like
Split the return of the endpoint modal to the following

{
 users: [], // A list of the users and their data.
 message: [] // A list of the messages
}

Use Faker.unique

Based on feedback in the Faker.js discord channel. We should consider updating our calls to use faker.unique instead.

Add Faker.js

Add the faker.js library in order to provide mock data easier. The framework already comes with a large qty of data creation classes to use and expose in the api

[New Mock] - Chat Feed

I have just introduced a new chat endpoint in version v.0.11.0 , However I would like to extend this to include an endpoint that is not random data but instead a mocked real conversation.
Maybe we could look into generating a conversation between two bots :)

[New Mock] - Email Feed

We will need a mock endpoint that returns fake email inbox of data.

A bunch of mocked data with (we can expand as we feel is needed)

  • ID
  • Date Sent
  • Sender Email
  • Read / Unread Status
  • Subject Line
  • Email Content
  • Tags

Auto Generate Swagger Docs

Our api docs currently use Swagger and need to be manually generated. I would be great to automate these.

[New Mock] - Image

Add Image endpoint using faker and their default Unsplash image provider.

[New Mock] - Reviews

  1. Add more real worded reviews for a series of fake products. eg. A Gaming Sports drink, a new dvd player etc. (The more we do the merrier)
  2. Add fake worded reviews for a fake product using faker.lorem.sentence the same way we do in getRandomChat

[New Mock] - Social Feed

Need to create a fake social feeds. We can do one PR per social event

  • Facebook
  • Instagram
  • Twitter

We still need to also decide what info needs to be mocked.

Add Docker support

The ability to run the project inside a docker container so that Node/NPM isn't required as a pre-requisite, and you have an isolated development environment. The only pre-requisite that would be required would be Docker.

blog with more information about the benefits of using Docker

Add an Album to music endpoint

A user can request a random album which will include a response with the following data.

  • Album Name
  • Album Artist
  • Date Released
  • Price
  • Publisher
  • Random number of songs up to max 20

Prettier

Is your feature request related to a problem? Please describe.
I struggle with formatting in this project with my existing Prettier (vscode) config.

Describe the solution you'd like
I think it would be great to have a Prettier configuration for this project, so we can go forward without worrying about formatting.

[New Mock] : Chemical Element

A endpoint to return a random chemical element, with its symbol, name and atomic number. If possible, I'd like to be assigned to this issue.

Adding Movies rating data

Is your feature request related to a problem? Please describe.
API with a bunch of movie related content is useful and can also be used as a valid data for recommendation systems too.

Describe the solution you'd like
I could be better if it's about movie, rating and other information

Need a logo

The site needs a logo that can be used on stickers, t-shirts etc.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.