Mockingbird is a robust tool for creating and managing mock environments, enhancing productivity, and streamlining integration. It integrates with Git for a simple and secure solution to develop and test APIs without additional servers.
- Intuitive Interface: Easy-to-use UI for project and server management.
- Git Integration: Works seamlessly with your Git setup.
- Multiple Environments: Manage various servers and mock environments.
- Customizable Responses: Define responses using functions, objects, or proxies.
- Presets: Create collections of routes with selected responses for efficient testing and debugging.
- GraphQL support: Define requests with graphQL schema support + record GraphQL requests.
- Download the latest version from the Releases page.
- Run the installer and follow the instructions.
- Launch Mockingbird: Open the application.
- Start a New Project:
- Clone an existing project from your Git service.
- Create a new local project (you can connect it to Git later).
- Open an existing project.
- Choose HTTPS or SSH cloning.
- Enter the repository URL and provide a unique name.
- Click
CLONE
to set up your project.
- New Server: Click
+ new server
, name it, and hitSAVE
. - New Parent: Add a parent to hold routes, specify the path and filename.
- Add Route: Define the HTTP method and path, then add the route.
- Add Response: Choose between function, object, or proxy responses, set response details, and save.
- Start your server and get the server address.
- Change the
baseUrl
in your project to direct API calls to the Mockingbird server. - Use the console to view requests handled by Mockingbird.
-
Set Up Your Server:
- Open server details.
- Enter your real server's base URL in the Target URL field to let Mockingbird act as a proxy.
-
Redirect Your Application:
- Click
Start Server
. - Replace your live server URL with the Mockingbird server URL in your application code.
- Click
-
Monitoring API Calls:
- Use the Mockingbird console to view all API requests and how they are handled.
-
Creating Local Routes:
- Add Parent: Define the parent path.
- Add Route: Add specific routes.
- Add Response: Define responses for routes.
Presets in Mockingbird are collections of routes with selected responses. Applying a preset updates the active responses on all routes in the preset to their specified responses. This feature is particularly useful for:
- QA Automation and Manual QA: Quickly switch between different test scenarios.
- Developers: Debug specific scenarios efficiently without manually changing each route.
To create a preset:
- Define a collection of routes.
- Select the desired responses for each route.
- Save the preset.
To apply a preset:
- Select the desired preset from the list.
- Apply the preset to update all active responses.
Mockingbird is dual-licensed under the GNU Affero General Public License v3.0 (AGPLv3) for open-source use and a commercial license for proprietary use. For more details, see LICENSE and COMMERCIAL_LICENSE.
We welcome contributions to Mockingbird! Please read and agree to our Contributor License Agreement (CLA) before contributing. For more details, see CONTRIBUTING.
For more details, visit the following articles:
-
Open terminal and Run Command:
`xattr -c /Applications/Mockingbird.app`
-
Verify Mockingbird:
- Once the command has been executed successfully, try running Mockingbird again.
For support or inquiries, contact us at [email protected]
Spread your wings with Mockingbird! 🚀