mockoon/mockoon
Mockoon
Mockoon is an HTTP API simulation platform and design tool used to create fake API endpoints that simulate server responses without a backend. It functions as an OpenAPI mock server tool and a JSON API mocking utility, allowing for the rapid iteration of API contracts and the generation of response templates.
The project distinguishes itself through a combination of stateful mocking, using a local JSON database to simulate CRUD operations, and the ability to run as a headless API mock server via a command line interface. It supports real-time collaborative editing and AI-assisted prototyping to generate initial mock structures and response bodies.
The platform covers a broad range of simulation capabilities, including dynamic route matching, webhook simulation, and network latency emulation for resilience testing. It integrates with OpenAPI workflows through specification imports and exports, and provides tools for capturing live traffic to create accurate mocks.
Deployment options include Docker image generation, cloud hosting, and integration into CI/CD pipelines. Installation is supported via system package managers.
Features
- Frontend API Mocking - Creates fake API endpoints with dynamic data to enable frontend development without a completed backend.
- API Mocking Servers - Provides local API endpoints that simulate server responses to remove dependencies on external services.
- API Prototyping Environments - Provides a comprehensive environment for rapidly iterating on API contracts and generating response templates.
- JSON-Based Persistence - Simulates database operations by performing CRUD actions against a local JSON file to maintain state.
- Mock State Management - Uses a local JSON database to simulate CRUD operations and maintain state between requests.
- Specification Conversions - Translates OpenAPI specifications into internal configuration files to automate mock server setup.
- Route Pattern Matching - Supports matching incoming requests to specific mock responses using regular expressions.
- Headless Server Deployments - Executes mock servers via a command line interface for use in remote environments and automation.
- API Response Simulators - Simulates diverse server scenarios by creating dynamic responses and emulating network latency.
- Mock Server Generators - Converts OpenAPI or Swagger files into functional mock servers to align development with API design documents.
- API Integration Testing - Simulates network latency and error codes to verify application handling of real-world API behavior.
- API Mocking - Simulates API responses to facilitate development and testing within Docker containers and CI/CD pipelines.
- Headless Execution - Ships a command line interface for running mock API environments within Docker containers and CI/CD pipelines.
- Mocking Tools - Simulates stateful JSON API responses and CRUD operations using a local JSON database.
- Response Body Templating - Generates variable response bodies based on incoming request data using JSON templating.
- Response Templating - Uses a templating engine to inject request data and environment variables into response bodies and headers.
- Response Body Generation - Allows the creation of realistic mock response bodies and data structures using natural language prompts.
- Seeded Generation - Produces predictable sequences of fake data using seeds to ensure consistent testing results.
- Mock-to-Spec Conversion - Converts mock environment files into OpenAPI v3 specifications for documentation purposes.
- API Specification Importers - Automates route setup by importing Swagger or OpenAPI files to create functioning mock servers.
- Web-Based Mock Management - Provides a web application to design and deploy mock APIs without requiring local installations.
- CI/CD Pipeline Integrations - Enables running mock API servers within containers for automated testing in CI/CD pipelines.
- Image Generation - Generates Dockerfiles and packages environments to create self-contained images of the mock API.
- Mock Cloud Hosting - Publishes mock APIs to a hosted cloud environment for sharing with external stakeholders.
- Event-Driven Webhooks - Triggers asynchronous HTTP callback requests to external systems to mimic server-side behaviors.
- HTTP Traffic Logging - Records full request and response details for every call with support for sensitive header redaction.
- Real-time Collaboration Services - Provides infrastructure for team members to edit mock APIs simultaneously in real time.
- Environment Variable Injection - Injects operating system environment variables into route responses for dynamic configuration.
- Mock Environment Generators - Converts OpenAPI specifications in JSON or YAML format into mock environment files.
- Artificial Latency Injection - Introduces artificial delays to requests to verify application timeout and retry logic.
- HTTP Traffic Recording - Captures real HTTP requests and replays them to ensure applications function correctly with real-world data.
- Response Simulators - Serves multiple different responses for a single route based on random selection or specific trigger rules.
- Webhook Simulation - Triggers callback requests to external systems to mimic complex asynchronous API behaviors.
- Traffic Recorders - Provides tools to capture real HTTP requests and responses from live servers to create accurate mock definitions.
- AI-Assisted Generation - Provides AI assistants to automatically generate initial mock API structures and endpoint definitions.
- Request Interception Middleware - Intercepts unmatched requests and forwards them to a remote server to combine live and mocked data.
- Mock-to-Real Routing - Forwards unmatched or specific requests to a real backend server to blend mocked and live responses.
- API Development - Desktop tool for creating and testing mock REST APIs.
- API Development Tools - Tool for creating and running mock APIs locally.
- Mocking Tools - Tool for designing and running mock REST APIs.
