Для информации по установке и запуску см. основной README
Основной REST API для управления личными финансами.
Позволяет работать со счетами, транзакциями, шаблонами и регулярными операциями.
- Регистрация и аутентификация (JWT)
- Управление счетами
- Управление категориями транзакций
- Управление транзакциями и переводами между счетами
- Управление шаблонами транзакций
- Поддержка регулярных транзакций
- gRPC интерфейс для взаимодействия с микросервисом Repetition Service
| Метод | Путь | Описание |
|---|---|---|
| POST | /api/v1/auth/signup | Регистрация пользователя |
| POST | /api/v1/auth/login | Вход, получение access и refresh токенов |
| POST | /api/v1/auth/refresh | Обновление токенов |
| Метод | Путь | Описание |
|---|---|---|
| GET | /api/v1/accounts | Получить все аккаунты |
| GET | /api/v1/accounts/{id} | Получить аккаунт по ID |
| POST | /api/v1/accounts | Создать новый аккаунт |
| PATCH | /api/v1/accounts/{id} | Обновить аккаунт |
| DELETE | /api/v1/accounts/{id} | Удалить аккаунт |
| GET | /api/v1/accounts/balances | Получить балансы по аккаунтам |
| Метод | Путь | Описание |
|---|---|---|
| GET | /api/v1/transactions/categories | Получить все категории |
| GET | /api/v1/transactions/categories/{id} | Получить категорию по ID |
| POST | /api/v1/transactions/categories | Создать категорию |
| PATCH | /api/v1/transactions/categories/{id} | Обновить категорию |
| DELETE | /api/v1/transactions/categories/{id} | Удалить категорию |
| Метод | Путь | Описание |
|---|---|---|
| GET | /api/v1/transactions | Получить все транзакции |
| GET | /api/v1/transactions/{id} | Получить транзакцию по ID |
| POST | /api/v1/transactions | Создать транзакцию |
| PATCH | /api/v1/transactions/{id} | Обновить транзакцию |
| DELETE | /api/v1/transactions/{id} | Удалить транзакцию |
| Метод | Путь | Описание |
|---|---|---|
| GET | /api/v1/transactions/templates | Получить все шаблоны |
| GET | /api/v1/transactions/templates/{id} | Получить шаблон по ID |
| POST | /api/v1/transactions/templates | Создать шаблон |
| PATCH | /api/v1/transactions/templates/{id} | Обновить шаблон |
| DELETE | /api/v1/transactions/templates/{id} | Удалить шаблон |
| Метод | Путь | Описание |
|---|---|---|
| GET | /api/v1/transfers | Получить все переводы |
| GET | /api/v1/transfers/{id} | Получить перевод по ID |
| POST | /api/v1/transfers | Создать перевод |
| PATCH | /api/v1/transfers/{id} | Обновить перевод |
| DELETE | /api/v1/transfers/{id} | Удалить перевод |
| Метод | Путь | Описание |
|---|---|---|
| GET | /api/v1/transactions/regulars | Получить все регулярные транзакции |
| GET | /api/v1/transactions/regulars/{id} | Получить регулярную транзакцию по ID |
| POST | /api/v1/transactions/regulars | Создать регулярную транзакцию |
| PATCH | /api/v1/transactions/regulars/{id} | Обновить регулярную транзакцию |
| DELETE | /api/v1/transactions/regulars/{id} | Удалить регулярную транзакцию |
API-сервис предоставляет gRPC сервис ApiService, который используется сервисом повторений для добавления транзакций на основе правил.
Repetition Service вызывает AddTransaction, чтобы зафиксировать транзакцию, созданную по правилу.
Это позволяет API-сервису хранить и отображать все транзакции, включая регулярные.
Этот проект распространяется под лицензией MIT. Подробнее см. в файле LICENSE.