![API](.github/social-card.png)

# Interface API

<div align="center">
<a href="https://www.npmjs.com/package/@antelopejs/interface-api"><img src="https://img.shields.io/npm/v/@antelopejs/interface-api?style=for-the-badge&labelColor=000000&color=000000" alt="npm"></a>
<a href="./LICENSE"><img alt="License" src="https://img.shields.io/badge/License-Apache_2.0-blue.svg?style=for-the-badge&labelColor=000000"></a>
<a href="https://discord.gg/sjK28QHrA7"><img src="https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000" alt="Discord"></a>
<a href="./docs/1.introduction.md"><img src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000" alt="Documentation"></a>
</div>

A decorator-based framework for building HTTP services with TypeScript. Interface API provides a clean, declarative syntax for defining routes, handling requests, managing responses, and supporting WebSocket connections.

## Installation

```bash
npm install @antelopejs/interface-api
```

## Documentation

Detailed documentation is available in the `docs` directory:

- [Introduction](./docs/1.introduction.md) - Overview and core concepts
- [Controllers](./docs/2.controllers.md) - Creating and organizing API controllers
- [HTTP Handling](./docs/3.http-handling.md) - Request and response handling
- [Parameter Handling](./docs/4.parameters.md) - Parameter injection and transformation

## License

This project is licensed under the Apache License 2.0 - see the [LICENSE](LICENSE) file for details.