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

Документация ссылки конечной точки API состоит из пяти основных разделов:

описания ресурсов;
конечные точки и методы;
параметры;
примеры запросов;
примеры ответов и схем.

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

Содержание модуля "Документирование конечных точек"

Документирование новой конечной точки

Обзор пошагового описания API ссылки

Шаг 1: Описание ресурса

Шаг 2: Конечные точки и методы

Шаг 3: Параметры

Шаг 4: Пример запроса

Шаг 5: Пример и схема ответа

Собираем все вместе

Практическое занятие: Что не так в разделе API?

Практическое занятие: Поиск open-source проекта

Практическое занятие: Оценка ключевых элементов API документации