Вставьте объявления interface, псевдонимов type, enum или классов на TypeScript и получите пример JSON-документа, который им удовлетворяет. Union литералов, Record, утилитарные типы вроде Pick, Omit и Partial и интерфейсы, связанные цепочкой extends, — всё это отслеживается и заполняется.
Используйте ещё до появления API, чтобы подготовить mock-данные для MSW или json-server, создать пропсы для Storybook или точно показать бэкенд-команде, какую форму вы хотите от них получать.
types.ts. Вперемешку могут идти export, import и объявления функций; читаются только объявления типов.enum, на которые есть ссылки, чтобы они заполнились. Имена типов, отсутствующих во вводе, становятся null.type UserPage = Page<User>, предпочитается самому обобщённому объявлению.HttpResponse.json(...) обработчика MSW, тестовую фикстуру или args в Storybook, затем поправьте значения.type Channel = "email" | "sms" | "push";
enum Priority { Low = "low", High = "high" }
interface Notification {
id: string;
channel: Channel;
priority: Priority;
recipient: { userId: number; locale?: string };
payload: Record<string, string>;
readAt: Date | null;
meta: Pick<Audit, "createdBy">;
}
interface Audit { createdBy: string; createdAt: Date }{
"id": "",
"channel": "email",
"priority": "low",
"recipient": {
"userId": 0,
"locale": ""
},
"payload": {
"key": ""
},
"readAt": "1970-01-01T00:00:00.000Z",
"meta": {
"createdBy": ""
}
}Channel — union строковых литералов, поэтому берёт первое значение "email"; строковый enum Priority берёт значение первого члена "low". Record<string, string> становится объектом с единственным "key", Date | null разрешается в не-null сторону как ISO-строка, а Pick<Audit, "createdBy"> оставляет только выбранный ключ. Необязательный locale? тоже включён.
string → "", number/bigint → 0, boolean → false, any/unknown → null, Date → 1970-01-01T00:00:00.000Z (формат Date.toJSON()).null/undefined, а пересечения (A & B) и interface ... extends объединяют свойства.enum использует значение первого члена или 0 для числового enum без инициализаторов.Array<T> и Set<T> получают один элемент-пример; кортежи — значение на каждую позицию; Record<K, V>, Map и индексные сигнатуры становятся {"key": V}.Partial, Required, Readonly, NonNullable, Pick и Omit.static, аксессоры get/set и поля с @Exclude().children: TreeNode[]) обрываются пустыми массивами.Пока бэкенд не готов, генерируйте mock-данные из типов ответов API. UI можно собрать первым, а при переходе на реальный API типы останутся теми же.
Создайте объект по умолчанию из типа пропсов компонента для args истории или данных рендера в React Testing Library. Все обязательные свойства на месте, так что гоняться за ошибками типов не придётся.
Превратите тип запроса фронтенда в JSON и вставьте его в документ по дизайну API или в issue — бэкенд-разработчики, не пишущие на TypeScript, сразу прочитают структуру.
?) включаются всегда; чтобы протестировать ответы без них, удалите ключи сами.type UserPage = Page<User> поле items: T[] заполняется User, а значения по умолчанию вроде <T = string> применяются, если аргумент не передан. Условные типы внутри дженериков всё же не вычисляются.T["key"], условные типы и шаблонные литеральные типы не вычисляются.name = "kim", retries = 3), использует это значение; другие инициализаторы, вроде new Date(), лишь подсказывают тип.z.infer, как обычный интерфейс.Map и Set показываются как объект и массив, но JSON.stringify превращает оба в {}, так что в типах ответов лучше использовать Record или массивы.Date выводится строкой?Да. JSON.stringify заменяет Date результатом её toJSON() — строкой ISO 8601. Принимающая сторона всё равно получает строку, так что либо типизируйте её как string, либо разбирайте.
status: "active" | "inactive"?Первый литерал в порядке объявления — "active". Если хотите показать другое значение, переставьте члены union.
Объявления классов и декораторы разбираются, так что DTO с декораторами class-validator преобразуются нормально, а поля с @Exclude() из class-transformer не выводятся.
Для обратного направления используйте страницу JSON → TypeScript. Отдельные страницы также генерируют JSON из моделей TypeORM, Sequelize и Mongoose.