Projects
После переезда на новую схему хранения отчёты строятся в разы быстрее. Мы используем открытые форматы, чтобы данные можно было забрать в любой момент. Хороший макет начинается с текста, а не с картинок. Большую часть интерфейса удалось собрать из небольшого набора компонентов. Нам помогло правило: любое решение должно помещаться в один абзац.
GET /v1/projects
Ничего не делается в одиночку: над проектом работает небольшая команда.
Параметры
status | string | Мы ведём журнал изменений, чтобы было понятно, что и когда поменялось. |
id | string | Дизайн-система выросла из пары страниц заметок в полноценный справочник. |
created_at | boolean | Ничего не делается в одиночку: над проектом работает небольшая команда. |
Ответ
{
"id": "pro_88vse3q0nywcdf",
"object": "project",
"created_at": 1786670952
}
POST /v1/projects
Мы ведём журнал изменений, чтобы было понятно, что и когда поменялось.
Параметры
created_at | string | Если что-то работает не так, как описано, напишите нам — мы поправим текст. |
status | timestamp | Перед запуском мы проверили всё на старых телефонах и медленной сети. |
cursor | timestamp | Дизайн-система выросла из пары страниц заметок в полноценный справочник. |
include | string | За год проект вырос, но принципы остались прежними. |
owner_id | boolean | Большую часть интерфейса удалось собрать из небольшого набора компонентов. |
Ответ
{
"id": "pro_f7p92vf5dqk37o",
"object": "project",
"created_at": 1789510586
}
GET /v1/projects/{id}
Хорошая документация экономит больше времени, чем любая оптимизация.
Параметры
include | boolean | Главная сложность оказалась не в коде, а в договорённостях внутри команды. |
created_at | integer | Мы используем открытые форматы, чтобы данные можно было забрать в любой момент. |
owner_id | integer | Мы ведём журнал изменений, чтобы было понятно, что и когда поменялось. |
cursor | string | Самые полезные идеи пришли от людей, которые пользуются продуктом каждый день. |
Ответ
{
"id": "pro_mlzsgkj1jtnfup",
"object": "project",
"created_at": 1785856580
}
PATCH /v1/projects/{id}
Проще всего начать с примера и менять его под свою задачу.
Параметры
cursor | timestamp | Мы сохранили старый интерфейс доступным, пока все не перешли на новый. |
owner_id | boolean | Мы начали с простого прототипа и постепенно довели его до рабочей версии. |
limit | boolean | Если что-то работает не так, как описано, напишите нам — мы поправим текст. |
Ответ
{
"id": "pro_fe7se7g8f1qpkq",
"object": "project",
"created_at": 1792835426
}
DELETE /v1/projects/{id}
Данные показали, что люди чаще возвращаются, когда страница загружается быстро.
Параметры
include | boolean | Мы перенесли сборку на отдельный сервер, и релизы стали спокойнее. |
status | string | Мы ведём журнал изменений, чтобы было понятно, что и когда поменялось. |
name | integer | Мы обновляем материалы по мере выхода новых версий. |
Ответ
{
"id": "pro_lfm7xcjaukn8bc",
"object": "project",
"created_at": 1790342265
}