Mock Api Hub

Introduction · Guide · Installation · Contributing · License

Made with ❤️

⚡ Introduction

A free simulated API designed to facilitate testing and experimentation. This service ensures the simplicity of the development process. All data in json format is created using ChatGPT.

📑 Guide

Fetching data using bash:

curl https://mock-api-hub.ru/api/v1/addresses/1

Fetching data using JavaScript:

fetch('https://mock-api-hub.ru/api/v1/addresses/1')
      .then(response => response.json())
      .then(json => console.log(json))

Resources	Count
/api/v1/addresses	100
/api/v1/books	100
/api/v1/comments	100
/api/v1/companies	100
/api/v1/courses	100
/api/v1/employees	100
/api/v1/events	100
/api/v1/messages	100
/api/v1/notifications	100
/api/v1/orders	100
/api/v1/posts	100
/api/v1/products	100
/api/v1/projects	100
/api/v1/recipes	100
/api/v1/reviews	100
/api/v1/todos	100
/api/v1/users	100

Methods	Routes
GET	/api/v1/addresses
GET	/api/v1/addresses/1
GET	/api/v1/addresses?page=1
GET	/api/v1/addresses?size=5
GET	/api/v1/addresses?sort=city
GET	/api/v1/addresses?direction=DESC
GET	/api/v1/addresses?country=China
POST	/api/v1/addresses
PUT	/api/v1/addresses/1
PATCH	/api/v1/addresses/1
DELETE	/api/v1/addresses/1

Note
The server won't actually update the resource, but it will simulate the update as if it did.

🛠️ Installation

You can install this project locally:

1. Install Docker.
2. Clone this repository:

   git clone https://github.com/nell-shark/mock-api-hub

3. Run all containers with:

   docker compose up

4. If everything goes well, you can start using it:

   curl http://localhost/api/v1/addresses

🤝 Contributing

If you are interested in contributing to this project, I highly recommend checking out the contributing guidelines.

⚖️ License

This project is licensed under the MIT License.