Бери и делай: как документировать GraphQL API, чтобы разработчики были в восторге
-
Просто
-
40 мин
«Матерь господня, вот это да!» — такой комментарий я получил от лида команды разработки, когда показал ему финальную версию документации на GraphQL API (скрин сообщения увидите на слайде :), когда придете на доклад).
В докладе в общих чертах расскажу про GraphQL API, его отличительные особенности и нюансы.
Также расскажу про способы документирования GraphQL API и про 3
формы документации для таких API:
- Документирование в GraphQL (GraphQL Playground).
- Подготовка статического сайта-справочника.
- Ознакомительная документация на GraphQL на док-портале для разработчиков или пользователей.
Расскажу, где и как техписатель может быстро развернуть свой собственный GraphQL API, чтобы потренироваться взаимодействовать с ним через Postman или GraphQL Playground.
Дам ссылку на полезные материалы, с которыми вы сможете быстро развернуть в облаке свой GraphQL API, и «пощупать» его со всех сторон.