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

32 lines
1.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
**Импорт константы API_BASE_URL из файла constants**:
```
import { API_BASE_URL } from '~/constants'
```
**Импорт путей API из файла openapi.gen**:
```
import type { paths } from '~/openapi.gen'
```
**Типы запросов и ответов для обновления и создания пользователя**:
```
type UserSetting =
paths['/user']['put']['requestBody']['content']['application/json'];
type UpdateUserResponse =
paths['/user']['put']['responses']['200']['content']['application/json'];
type CreateUserResponse =
paths['/users']['post']['responses']['201']['content']['application/json'];
```
**Функции для работы с пользователями**:
- `updateUser`: Функция для обновления данных пользователя.
- `createUser`: Функция для создания нового пользователя.
- `getUser`: Функция для получения данных пользователя.
**Типы и функции для подписки и отписки от пользователя**:
```
export type FollowUserResponse =
paths['/profiles/{username}/follow']['post']['responses']['200']['content']['application/json'];
export type UnfollowUserResponse =
paths['/profiles/{username}/follow']['delete']['responses']['200']['content']['application/json'];
```
**Функции для подписки и отписки от пользователя**:
- `followUser`: Функция для подписки на пользователя.
- `unfollowUser`: Функция для отписки от пользователя.