Skip to content

Latest commit

 

History

History
170 lines (134 loc) · 15.3 KB

README.md

File metadata and controls

170 lines (134 loc) · 15.3 KB
Raw

GitHub repo size in bytes GitHub last commit GitHub watchers GitHub stars

Курс по документированию REST API

Вольный перевод курса Documenting APIs: A guide for technical writers, составленного Томом Джонсоном, техническим писателем Amazon.

Цель перевода курса:

  • пройти курс, научиться документировать API, повысить свои soft skills техписателя;
  • освежить знания английского языка;

Данный репозиторий используется для хранения исходников перевода.

Сайт русскоязычной версии курса: Starkovden.github.io

Коротко о курсе

Курс по написанию документации REST API предполагает практический подход к документированию REST API вместо лекций об абстрактных понятиях. На этом курсе займемся изучением документации API на примерах использования API сервисов прогноза погоды.

Разбирая API, мы узнаем о конечных точках, параметрах, типах данных, аутентификации, curl, JSON, командной строке, консоли разработчика Chrome, JavaScript и других деталях, связанных с REST API.

Идея курса в следующем: посмотреть на реальные сценарии использования API, вместо изучения концептов API независимо от контекста, что сделает этот курс намного эффективнее.

Во время прохождения курса мы изучим стандарты, инструменты и спецификации REST API. Узнаем о необходимых разделах в документации API, проанализируем примеры документации REST API различных компаний, узнаем, как присоединиться к проекту c открытым исходным кодом, чтобы получить опыт, и многое другое.

Начать обучение 👨‍💻

Модули курса

  1. Введение в REST API

  2. Использование API в роли разработчика

  3. Документирование конечных точек

  4. Спецификация OpenAPI и Swagger

  5. Тестирование документации

  6. Концептуальные разделы

  7. Публикация документации

  8. Работа технического писателя

  9. Нативные библиотеки API

  10. Глоссарий API и источники

  11. Документирование кода

Go next ➡