Курс о документировании API
Что это за курс
Курс о документации API, об инструментах и процессах, связанных с ней.
Расскажем о том, что такое REST API и OpenAPI. Изучим популярный инструментарий работы с документацией API: Swagger, Postman. Задокументируем настоящий API. Рассмотрим типовые процессы работы техписателя в связке с командой разработчиков.
Для кого
Этот курс адресован техписателям, уже имеющим опыт разработки различной документации, но еще не знакомым с концепциями API.
Программа курса
API: что это такое, какие виды API бывают и в каких сферах применяются.
Работа в команде с разработчиками ПО: участники команды разработки, роль технического писателя в ней.
REST API как наиболее популярный вид API. Особенности REST, форматы данных.
Виды документации API: жанры и структура. Детальный разбор каждого вида документации. Практическое задание.
Справочник API: спецификация OpenAPI. Заполняем справочник API, разбираем все объекты спецификации. Практическое задание.
Инструменты разработчиков для написания документации: виды инструментов и их использование техническим писателем. Практика написания документации в VS Code, отправка запросов к API через Postman. Практическое задание.
Публикация готовой документации: выбор подходящего варианта публикации. Swagger, Swagger UI, Swagger Editor. Публикация результатов с использованием различных инструментов. Практическое задание.
Формат курса
Курс проводится в формате живых вебинаров. После завершения курса участникам будут доступны видеозаписи всех занятий.
Для участия в курсе вам потребуется доступ к Zoom и Telegram. Практические задания будут включать в себя редактирование и написание OpenAPI-спецификаций, поэтому вам понадобится редактор кода вроде VS Code.
Часть практических заданий будет связана с работой со Swagger UI и Swagger Editor. Эти задания удобнее выполнять на большом мониторе (а не на ноутбуке или планшете).
Остались вопросы?
Прочитайте наш FAQ по курсам или напишите на info@documentat.io.
Продолжительность
6 дней: 25, 27, 29 ноября, 2, 4, 6 декабря
Время занятий
17:00 — 19:00 Мск
Ведущий курса
Денис Мазин
Руководитель команды технических писателей в TradingView.
В прошлом — технический писатель в компаниях documentat.io и Rarible.
Более шести лет занимаюсь разработкой документации API.