A progressive Node.js framework for building efficient and scalable server-side applications.

Description

AI Tools API - это RESTful API, построенное на фреймворке NestJS с TypeScript. Проект включает базовую структуру приложения с настроенными ESLint и Prettier.

Особенности проекта

• ✅ TypeScript - полная поддержка типизации
• ✅ Модульная архитектура - разделение на логические модули
• ✅ ESLint & Prettier - автоматическое форматирование и проверка кода
• ✅ Глобальные фильтры - обработка исключений
• ✅ Глобальные интерцепторы - логирование и трансформация ответов
• ✅ CORS - поддержка кросс-доменных запросов
• ✅ Валидация - автоматическая валидация входящих данных

Структура проекта

src/
├── audio/                 # Модуль обработки аудио
├── openai/                # Модуль интеграции с OpenAI
├── receipt/               # Модуль обработки чеков
├── common/                # Общие компоненты
│   ├── filters/           # Глобальные фильтры
│   └── interceptors/      # Глобальные интерцепторы
├── config/                # Конфигурация приложения
├── file/                  # Модуль работы с файлами
├── app.controller.ts      # Основной контроллер
├── app.service.ts         # Основной сервис
├── app.module.ts          # Корневой модуль
└── main.ts               # Точка входа приложения

API Endpoints

OpenAI

• POST /openai/chat - Отправка запроса к OpenAI Chat API
• POST /openai/completion - Отправка запроса к OpenAI Completion API

Audio

• POST /audio/analyze - Анализ аудио файлов

Receipt

• POST /receipt/analyze - Анализ чеков

Установка и запуск

1. Установка зависимостей

npm install

2. Запуск приложения

# Режим разработки
npm run start:dev

# Обычный запуск
npm run start

# Продакшн режим
npm run start:prod

Приложение будет доступно по адресу: http://localhost:3000

3. Команды для разработки

# Проверка кода ESLint
npm run lint

# Форматирование кода Prettier
npm run format

# Сборка проекта
npm run build

4. Тестирование

# Юнит тесты
npm run test

# E2E тесты
npm run test:e2e

# Покрытие тестами
npm run test:cov

# Тесты в режиме наблюдения
npm run test:watch

Примеры использования API

Отправка запроса к OpenAI Chat

curl -X POST http://localhost:3000/openai/chat \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Привет, как дела?"
  }'

Анализ аудио файла

curl -X POST http://localhost:3000/audio/analyze \
  -H "Content-Type: multipart/form-data" \
  -F "file=@audio.mp3"

Анализ чека

curl -X POST http://localhost:3000/receipt/analyze \
  -H "Content-Type: multipart/form-data" \
  -F "file=@receipt.jpg"

Deployment

When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the deployment documentation for more information.

If you are looking for a cloud-based platform to deploy your NestJS application, check out Mau, our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:

$ npm install -g @nestjs/mau
$ mau deploy

With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.

Resources

Check out a few resources that may come in handy when working with NestJS:

• Visit the NestJS Documentation to learn more about the framework.
• For questions and support, please visit our Discord channel.
• To dive deeper and get more hands-on experience, check out our official video courses.
• Deploy your application to AWS with the help of NestJS Mau in just a few clicks.
• Visualize your application graph and interact with the NestJS application in real-time using NestJS Devtools.
• Need help with your project (part-time to full-time)? Check out our official enterprise support.
• To stay in the loop and get updates, follow us on X and LinkedIn.
• Looking for a job, or have a job to offer? Check out our official Jobs board.

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.