IT Academy
Урок 4 · Начальный

Reference и API documentation

Объяснение → самостоятельное решение → разбор → практика курса

Объяснение

Reference описывает точный контракт: параметры, типы, значения по умолчанию, результат и ошибки. Пример должен быть исполнимым или явно обозначенным псевдокодом.

Задача для самостоятельного решения

Что нужно документировать у API кроме URL?

Показать разбор ответа

Метод, аутентификацию, вход, статусы, схему ответа, ошибки, ограничения, идемпотентность и пример с безопасными данными.

Примените знания

В лабораторной курса есть учебная среда, пример, ожидаемый результат и задание проекта. Возвращайтесь к ней по мере прохождения тем.

Открыть лабораторную →