PROD.2024/Pulse-API
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update protected files

Browse Source
This commit is contained in:
cu-workflow-launcher[bot]
2024-02-28 19:53:32 +00:00
committed by GitHub
parent baa5be9aea
commit b9a7654830
3 changed files with 142 additions and 77 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+20 -4
View File
@@ -47,7 +47,7 @@
Для получения баллов за группу тестов решение должно пройти все тесты из данной группы.
Группы тестов могут зависеть друг от друга. Если группа B зависит от группы B, при тестировании группы B могут использоваться эндпоинты, участвовавшие в тестировании группы A. Это свойство транзитивно!
Группы тестов могут зависеть друг от друга. Если группа B зависит от группы A, при тестировании группы B могут использоваться эндпоинты, участвовавшие в тестировании группы A. Это свойство транзитивно!
| Название группы | Описание | Баллы | От каких групп зависит |
|------------------|------------------------------------|-------|------------------------|
@@ -58,7 +58,7 @@
| 05/me | Получение и редактирование собственного профиля. | 8 | - 04/auth/sign-in |
| 06/profiles | Получение профиля по логину. | 5 | - 04/auth/sign-in |
| 07/password | Изменение пароля. | 7 | - 05/me |
| 08/friends | Друзья! | 12 | - 04/auth/sign-in |
| 08/friends | Друзья! | 12 | - 04/auth/sign-in<br>- 06/profiles |
| 09/posts/publish | Публикация поста и получение по ID. | 12 | - 05/me<br>- 08/friends |
| 10/posts/feed | Получение новостной ленты. | 16 | - 09/posts/publish |
| 11/posts/likes | Лайки и дизлайки. | 20 | - 10/posts/feed |
@@ -91,7 +91,7 @@
```json
{
"name": "полное название",
"alpha2": "двухбуквенный код страны",
"alpha2": "двухбуквенный код страны (в верхнем регистре)",
"alpha3": "трехбуквенный код страны",
"region": "географический регион"
}
@@ -125,6 +125,8 @@ INSERT INTO countries (name, alpha2, alpha3, region) VALUES
Приложение вправе менять содержимое СУБД. Если вам требуются дополнительные таблицы, создавайте их самостоятельно при старте приложения (не забудьте про `IF NOT EXISTS`).
При поиске страны по двухбуквенному коду можно реализовать регистрозависимый поиск, то есть пользователь всегда будет указывать значения в нужном регистре.
### 03/auth/register
Эндпоинт `/auth/register` используется для первичной регистрации пользователей.
@@ -158,6 +160,8 @@ INSERT INTO countries (name, alpha2, alpha3, region) VALUES
Обратите внимание, в некоторых ситуациях профиль пользователя получить нельзя (в зависимости от значения параметра `isPublic`). Для получения дополнительных деталей ознакомьтесь со спецификацией API.
В данной группе тестов не будет проверяться логика с друзьями пользователя.
### 07/password
С помощью `/me/updatePassword` у пользователя появляется возможность изменить пароль от своего аккаунта.
@@ -175,6 +179,8 @@ INSERT INTO countries (name, alpha2, alpha3, region) VALUES
В приложении появляется возможность добавлять и удалять других пользователей из списка своих друзей.
И конечно же можно посмотреть список своих друзей.
Свойство быть другом &mdash; одностороннее. Если Петя добавит Машу в друзья, то профиль Пети становится доступным для Маши, даже если у Пети закрытый профиль.
Чтобы не нагружать сервера и клиенты слишком сильно, в запросах на получение списка друзей используется пагинация.
С помощью параметров `offset` и `limit` можно "постранично" получить весь список друзей, запрашивая данные порционно.
@@ -250,7 +256,7 @@ INSERT INTO countries (name, alpha2, alpha3, region) VALUES
Для локального тестирования вы можете пользоваться [Postman](https://www.postman.com/). В директории проекта кто-то из коллег оставил [Postman коллекцию](./tests/public-tests.json) с публичными тестами для API. Не забудьте переопределить `base_url` в переменных коллекции.
Для инициализации СУБД PostgreSQL можно использовать [заранее подготовленный скрипт](./tests/init-database.sh), из которого можно выудить SQL запросы.
Для инициализации СУБД PostgreSQL можно использовать [заранее подготовленный скрипт](./tests/init-database.sh), из которого можно выудить SQL запросы. Обратите внимание, данный файл предназначен для локального тестирования. Тестирующая система не использует данный файл.
Чтобы локальное тестирование было максимально приближенным к тестированию в CI, мы рекомендуем запускать PostgreSQL и ваше приложение в Docker контейнерах (связанных одной сетью).
@@ -263,6 +269,16 @@ INSERT INTO countries (name, alpha2, alpha3, region) VALUES
Не забывайте делать `git pull --rebase`, чтобы загрузить актуальные требования в локальную версию репозитория.
### 28.02.2023
Коллеги передали, что связь "друзья" является односторонней.
Если профиль пользователя закрыт, доступ к его профилю и его публикациям появляется у пользователей, кого данный пользователь добавил в друзья.
При если это Маша добавила Петю в друзья, не значит, что Петя добавил Машу в друзья. Можно расценивать добавление в друзья как подписку.
Группа `08/friends` зависит от группы `06/profiles`.
### 27.02.2023
Коллеги, привет! Ничего критичного... Уговорили нашего Devops-инженера расширить список переменных с информацией для подключения к PostgreSQL. Смотрите секцию с описанием ENV переменных. Надеемся, теперь станет проще!