# Mockzilla

> A compile-safe solution for running and configuring a local HTTP server for your mobile apps. Supports Android, iOS, Kotlin Multiplatform and Flutter.

Mockzilla is a compile-safe mock HTTP server that runs embedded inside your mobile app during development and testing, letting you mock API responses without a real backend. It targets Android, iOS, Kotlin Multiplatform, Flutter and browser (JS/MSW) apps.

Install coordinates:
- Kotlin / Android / Kotlin Multiplatform (Maven Central): `com.apadmi:mockzilla` (plus `com.apadmi:mockzilla-common` for the shared models/DSL, and `com.apadmi:mockzilla-mobile-ui` for the embeddable in-app overlay).
- Flutter (pub.dev): `mockzilla`.
- Native iOS: `SwiftMockzilla` via Swift Package Manager (`https://github.com/Apadmi-Engineering/SwiftMockzilla.git`) or CocoaPods.

Important notes for code generation:
- There is NO standalone npm / JavaScript package. Do not use `npm install mockzilla`. Browser support (JS, backed by Mock Service Worker) is only reachable through the Flutter `mockzilla_web` plugin or the Kotlin/JS `com.apadmi:mockzilla` target.
- Mockzilla is a development and testing tool only. It must never be shipped to production.

## Docs

- [Quick Start](https://mockzilla.apadmi.dev/quick-start.md): Get started with Mockzilla in minutes. Add the dependency, configure your endpoints, and start a local mock HTTP server for your mobile app.
- [Configuring Endpoints](https://mockzilla.apadmi.dev/endpoints.md): Learn how to configure Mockzilla endpoints - define custom handlers for your mock HTTP server.
- [Web / JavaScript](https://mockzilla.apadmi.dev/web.md): Use Mockzilla in a browser app - Kotlin/JS, Kotlin Multiplatform web, or Flutter Web - backed by Mock Service Worker (MSW).
- [Additional Configuration](https://mockzilla.apadmi.dev/additional_config.md): Configure logging verbosity and Release Mode (rate limiting, token auth, and localhost-only access) for sharing mock builds with non-developers.
- [BrowserStack](https://mockzilla.apadmi.dev/browser_stack.md): Run Mockzilla on BrowserStack devices - iOS works out of the box; Android requires bypassing BrowserStack's local-traffic proxy in your HTTP client.
- [Snapshot builds](https://mockzilla.apadmi.dev/snapshots.md): Try unstable development (snapshot) builds of Mockzilla - Maven snapshot repo for Kotlin, snapshot branches for Swift, and pub.dev pre-releases for Flutter.
- [Mockzilla Desktop (beta)](https://mockzilla.apadmi.dev/desktop/overview.md): Download, connect to, and use the Mockzilla Desktop app to control your mocked endpoints live.
- [Mockzilla Mobile UI (alpha)](https://mockzilla.apadmi.dev/mobile_ui.md): Embed the Mockzilla control UI in your app to override responses and adjust the mock server at runtime - install instructions and launchManagementUi usage per platform.
- [Presets](https://mockzilla.apadmi.dev/presets.md): Define presets - canned responses configured in code and applied at runtime from the desktop app or embedded UI - and how partial preset overrides combine with your default handler.

## Optional

- [API Reference (Kotlin KDoc)](https://mockzilla.apadmi.dev/dokka/): Generated Dokka API reference for the Kotlin modules.
- [GitHub repository](https://github.com/Apadmi-Engineering/Mockzilla): Source, samples and issue tracker.