Документируйте API просто и быстро

Создавайте структурированную документацию эндпоинтов, описывайте параметры и ответы. Всё в одном месте — для вашей команды и клиентов.

Рабочее пространство разработчика

Всё необходимое для документации

Конструктор эндпоинтов, ресурсы ответов, папки — собирайте API как конструктор.

Эндпоинты

Описывайте методы, пути, query-параметры, заголовки, куки и тело запроса. Отмечайте обязательные поля звёздочкой.

Ресурсы ответов

Создавайте переиспользуемые шаблоны ответов и привязывайте их к эндпоинтам. Один ресурс — много эндпоинтов.

Папки

Группируйте эндпоинты по разделам. Логичная структура для больших API.

Полноэкранный просмотр

Открывайте детали эндпоинта на весь экран. Удобно для презентаций и демо.

Копирование в буфер

Копируйте примеры запросов и ответов одним кликом. Быстрая интеграция.

Командная работа

Проекты и воркспейсы для всей команды. Единый источник правды для API.

Превью эндпоинта

Удобный просмотр деталей: параметры, заголовки, тело запроса, примеры ответов.

Список пользователей
GET/api/v1/users
Query-параметры
pagenumberНомер страницы
limitnumberРазмер страницы
Ответ 200
[
  { "id": 1, "name": "...", "email": "..." }
]
Создание заказа
POST/api/v1/orders
Query-параметры
productIdstringID товара
quantitynumberКоличество
Ответ 200
{
  "id": "ord_123",
  "status": "created"
}
Поиск
GET/api/v1/search
Query-параметры
qstringПоисковый запрос
categorystringКатегория
Ответ 200
[
  { "slug": "...", "snippet": "..." }
]

Примеры использования

REST API, микросервисы, мобильные приложения — документируйте любой формат.

REST API

Бэкенд-сервисы

Документируйте CRUD, фильтры, пагинацию и коды ответов.

Микросервисы

Сервисная архитектура

Отдельный проект на каждый сервис. Связи через описания.

Мобильные API

Приложения

Авторизация, заголовки, версионирование — всё в одном месте.

Всё для вашей команды

Современный интерфейс, удобная навигация и быстрый доступ к документации.

Команда за работой

Готовы начать?

Создайте первый проект и начните документировать API за пару минут.

Зарегистрироваться бесплатно