Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/begenov/region-llc-task
Этот микросервис реализует функциональность управления списком задач.
https://github.com/begenov/region-llc-task
gin mongodb redis swagger zap
Last synced: 9 days ago
JSON representation
Этот микросервис реализует функциональность управления списком задач.
- Host: GitHub
- URL: https://github.com/begenov/region-llc-task
- Owner: begenov
- Created: 2023-08-04T13:42:40.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-10T12:51:44.000Z (over 1 year ago)
- Last Synced: 2024-06-21T03:32:03.527Z (5 months ago)
- Topics: gin, mongodb, redis, swagger, zap
- Language: Go
- Homepage:
- Size: 175 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Region Todo List
Этот микросервис реализует функциональность управления списком задач.
# Требования к запуску
### Предварительные требования
- Установленный Docker
- Установленный Docker Compose
## Установка и Запуск приложения
1. Клонируйте репозиторий проекта на свой компьютер:
```shell
git clone https://github.com/begenov/region-llc-task
```
2. Перейдите в директорию проекта:
```shell
cd ./region-llc-task
```
3. Запустите приложение с помощью Docker Compose:
```shell
make run
```
или
```shell
docker-compose up
```
4. Чтобы остановить приложение, выполните команду:
```shell
make stop
```
или
```
docker-compose down
```
### API Endpoints
#### ** Формат обмена данными JSON.**
#### Swagger документация доступна по адресу http://localhost:8080/swagger/index.html
## Создание новой Пользователя
1. Метод: POST
- URL: /api/v1/users/sign-up
- Тело запроса:
```json
{
"email":"[email protected]",
"username": "username",
"password": "password"
}
```
- Регистрирует нового пользователя
## Вход пользователя
2. Метод: POST
- URL: /api/v1/users/sign-in
- Тело запроса:
```json
{
"email":"[email protected]",
"password": "password"
}
```
- Вход пользователя.
## Обновление токена аутентификации
3. Метод: POST
- URL: /api/v1/users/auth/refresh
- Тело запроса:
```json
{
"refresh_token": "ваш-токен-обновления"
}
```
- Обновляет токен аутентификации.
## Создание задачи
4. Метод: POST
- URL: /api/v1/users/todo-list/tasks
- Авторизация: Bearer "ваш-доступ-токен"
- Тело запроса:
```json
{
"title": "Купить книгу",
"activeAt": "2023-08-04"
}
```
- Создание новой задачи
## Обновление задачи
5. Метод: PUT
- URL: /api/v1/users/todo-list/tasks/:id
- Авторизация: Bearer "ваш-доступ-токен"
- Тело запроса:
```json
{
"title": "Купить книгу - Высоконагруженные приложения",
"activeAt": "2023-08-05"
}
```
- Обновление существующей задачи.
## Удаление задачи
6. Метод: DELETE
- URL: /api/v1/users/todo-list/tasks/:id
- Авторизация: Bearer "ваш-доступ-токен"
- Удаление задачи.
## Пометить задачу выполненной
7. Метод: PUT
- URL: /api/v1/users/todo-list/tasks/:id/done
- Авторизация: Bearer "ваш-доступ-токен"
- Помечает задачу как выполненную.
## Список задач
8. Метод: GET
- URL: /api/v1/users/todo-list/tasks
- Авторизация: Bearer "ваш-доступ-токен"
- Получает список задач.
## Тестирование
Запуск unit тестов
```shell
make test
```