# ngx-api-mimic - Documentation for AI Agents

NgxApiMimic is a powerful Angular API Mock library for demo apps, recruitment tasks, and portfolios. It allows developers to mock data and create a full fake REST API under an Angular HTTP Interceptor. It is inspired by NestJS.

## Features
- **Data Mocking:** Generate data via TypeScript interfaces/schematics.
- **API Mocking:** Fake REST API features including Routers, Controllers, Decorators (e.g. `@Get()`, `@Post()`, `@Body()`, `@Query()`), Guards, and Pipes.
- **In-browser persistence:** Automated mock data storage in LocalStorage.
- **Easy NestJS migration:** Identical architecture and decorators to NestJS makes code migration seamless.

## Important Links
- GitHub: https://github.com/mateuszbilicz/ngx-api-mimic
- Docs: https://ngx-api-mimic.mateuszbilicz.pl/docs
- Search in Docs: https://ngx-api-mimic.mateuszbilicz.pl/docs?q={search_text}
- Full API Reference for LLMs: /llms-full.txt
- Author: Mateusz Bilicz (https://mateuszbilicz.pl)

## Usage Overview
1. Decorate your controllers: `import { Controller, Get, Post } from 'ngx-api-mimic';`
2. You can generate REST CRUD immediately by combining `@UsingSchema('store', targetSchema)` with your Controller.
3. Add the mock setup to your Angular app through an `HttpInterceptor`. Real Angular Data Services will hit the interceptor seamlessly.

*Note: This is intended for local/demo/sandbox usage, not for production backend servers.*