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

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

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

Тяжелых и скучных лекций об абстрактных понятиях здесь не будет.

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

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

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

Во время прохождения курса:

  • изучим стандарты, инструменты и спецификации REST API;
  • узнаем о необходимых разделах в документации API;
  • проанализируем примеры документации REST API различных компаний;
  • узнаем, как присоединиться к опен-сорс проекту, для получения опыта;
  • и многое другое.
Информация была полезна для вас?

Расскажите пожалуйста что мы можем улучшить?


Обзор Apiary

Разработка Мощный стек разработки API. Создан для разработчиков

Подробнее...


Обзор Swagger

Разработка Swagger - это программная среда с открытым исходным кодом, поддерживаемая большой экосистемой инструментов, которая помогает разработчикам проектировать, создавать, документировать и использовать веб-сервисы RESTful

Подробнее...