Files
we_pro_dock/FRONTEND/API/TODO.md
2024-05-14 11:39:33 +03:00

1.7 KiB
Raw Blame History

Импорт константы API_BASE_URL из файла constants:

import { API_BASE_URL } from '~/constants'

Импорт путей API из файла openapi.gen:

import type { paths } from '~/openapi.gen'

Типы ответов на запросы к API для получения задач и комментариев:

export type GetTodosResponse =
  paths['/todos']['get']['responses']['200']['content']['application/json'];
export type GetTodoResponse =
  paths['/todos/{id}']['get']['responses']['200']['content']['application/json'];
export type GetTodoCommentsResponse =
  paths['/todos/{id}/comments']['get']['responses']['200']['content']['application/json'];

Типы запросов для создания задачи и комментария к задаче:

type CreateTodosRequest =
  paths['/todos']['post']['requestBody']['content']['application/json'];
type CreateTodoCommentRequest =
  paths['/todos/{id}/comments']['post']['requestBody']['content']['application/json'];

Функции для работы с задачами и их комментариями:

  • createTodo: Функция для создания новой задачи.
  • updateTodo: Функция для обновления данных задачи.
  • removeTodo: Функция для удаления задачи.
  • createTodoComment: Функция для добавления комментария к задаче. Функции для работы с избранными задачами:
  • addTodoToFavorites: Функция для добавления задачи в избранное.
  • removeTodoFromFavorites: Функция для удаления задачи из избранного.