Skip to main content
✱ Описание API/SDK, Docs as Code

Бери и делай: как документировать GraphQL API, чтобы разработчики были в восторге

Techwriter Days #2
2025-03-28 16:00
Секция A
40 мин
Просто
Доклад был на прошедшей конференции Techwriter Days #2 и сейчас находится в архиве.
Денис Ребенок – технический писатель компании FL, делится секретами, как документировать GraphQL API так, чтобы разработчики были в восторге. На уже прошедшей конференции Techwriter Days многим из нас удалось раскрыть тайны документирования этой технологии. Если ты ещё не знаешь, что такое GraphQL, то самое время это исправить. Денис не просто рассказал о различиях между GraphQL и привычными REST API, но и показал, как с помощью схемы, создания статических справочников и комментариев сделать документацию доступной и полезной. Основываясь на своем опыте, Денис выделяет важность точного нейминга и раскрывает, как технически оснастить документацию кодом для облегчения её восприятия. Его доклад — это не только теоретическая база, но и практические советы, которые помогут вам улучшить процессы документирования и вдохновят на новые подходы. Узнайте больше, посмотрев видео с доклада.
«Матерь господня, вот это да!» — такой комментарий я получил от лида команды разработки, когда показал ему финальную версию документации на GraphQL API (скрин сообщения увидите на слайде :), когда придете на доклад). В докладе в общих чертах расскажу про GraphQL API, его отличительные особенности и нюансы. Также расскажу про способы документирования GraphQL API и про 3 формы документации для таких API: — Документирование в GraphiQL Playground. — Подготовка статического сайта-справочника. — Ознакомительная документация на GraphQL на док-портале для разработчиков или пользователей. Расскажу, где и как техписатель может быстро развернуть свой собственный GraphQL API, чтобы потренироваться взаимодействовать с ним через Postman или GraphQL Playground. Дам ссылку на полезные материалы, с которыми вы сможете развернуть локально GraphQL API и «пощупать» его со всех сторон.

Доступно только после покупки 😊

Другие доклады Techwriter Days #2