Как это устроено
Адрес мока состоит из трёх частей, и каждая соответствует своей сущности.
https://<команда>.<домен>/<проект>/<ресурс>
└── организация └── проект └── коллекция
Организация
Организация владеет проектами, участниками, тарифом и счётчиком запросов. Её имя — слаг — занимает поддомен.
Данные одной организации недоступны другой. Обращение к чужому проекту отвечает 404 — так же, как к несуществующему.
Проект
У проекта свои настройки: нужен ли для доступа API-ключ, включён ли chaos-режим, какие маршруты в нём заведены. Имя проекта — первый сегмент пути.
Коллекция и маршруты
Коллекция — это набор записей с общей схемой. При её создании появляются пять маршрутов:
| Маршрут | Что делает |
|---|---|
GET /<ресурс> | Страница записей |
POST /<ресурс> | Создать запись |
GET /<ресурс>/:id | Одна запись |
PATCH /<ресурс>/:id | Частичное обновление |
DELETE /<ресурс>/:id | Удаление |
Поле id в ответе есть всегда — по нему запись адресуется в остальных четырёх маршрутах. Хранится оно отдельно от остальных полей, поэтому запись с собственным полем id в теле не подменит свой адрес.
Состояние
Записи хранятся. То, что создано через POST, вернётся в GET завтра и у любого участника команды: это настоящий бэкенд с данными, а не заранее записанный ответ.