Документация API в OpenAPI и Swagger
Опишем существующий REST API в OpenAPI, подготовим примеры запросов и страницу документации. Проверим примеры в вашей тестовой среде и зафиксируем расхождения между описанием и ответами.
Спецификация OpenAPI, портал Swagger UI, примеры и воспроизводимый набор проверок для десяти операций API.
Вы поручаете задачу нашей команде. Мы уточним требования, выполним работу и проверим результат перед передачей.
Выберите состав работ
10 операций, 20 схем, 1 авторизация, до 20 sandbox-проверок и Swagger UI
От 8 рабочих днейОбсудить этот вариант ↗Бизнесот 79 900 ₽25 операций, 40 схем, 1 авторизация, до 50 sandbox-проверок и Swagger UI
От 12 рабочих днейОбсудить этот вариант ↗Расширенныйот 119 900 ₽50 операций, 80 схем, 1 авторизация, до 100 sandbox-проверок и Swagger UI
От 18 рабочих днейОбсудить этот вариант ↗Базовый состав работы описан выше. Отличия расширенных вариантов указаны в их описании. Индивидуальные дополнения оценим до начала работы.
Начнём с понятного примера
До оплаты покажем описание одной операции, её схему и пример запроса по предоставленным материалам; укажем, чего не хватает для проверки в sandbox.
Сначала согласуем небольшой показательный фрагмент или диагностику. Он поможет оценить направление работы без предоплаты. Для большого проекта затем согласуем этапы, стоимость и оплату.
Проверим, что результат работает
Проверим разрешение ссылок схем, обязательные поля, типы и примеры. В sandbox сверим коды и поля фактических ответов, очистим созданные тестовые сущности доступным штатным способом. Секреты заменим переменными. Неподтверждённое поведение отметим в отчёте. Два раунда правок.
Два раунда правок в рамках согласованной задачи. Для каждого раунда собираем правки одним списком. Передаём итоговые файлы или доступы в аккаунте клиента и поясняем, как пользоваться результатом.
Достаточно рассказать о задаче
Для первой заявки нужны имя и контакт. Подробности можно обсудить с командой позже.
- Список операций, текущая документация или доступ к относящемуся к API исходному коду
- Изолированный sandbox, тестовый аккаунт и способы создания/очистки тестовых данных
- Ответственный разработчик, правила ошибок и место размещения документации
Что не входит в пакет
- Разработка и исправление самого API, SDK и нового способа авторизации
- GraphQL, gRPC, WebSocket, файловые потоки и несколько версий API
- Нагрузочные проверки, пентест, оценка безопасности и сертификация
- Запросы с изменением реальных данных, оплата хостинга и постоянное ведение документации
Платные лицензии, подписки, сторонние API, комиссии, домен и хостинг не включены, если в составе прямо не указано обратное. Срок начинается после согласования и получения материалов.
Ответы перед заказом
Мне нужно самому разбираться в настройках?
Нет. Расскажите, что должно получиться. Команда объяснит варианты, настроит согласованные функции и передаст инструкцию. Для платёжных и других внешних сервисов понадобятся ваши аккаунты и подтверждения владельца.
Это готовый файл или работа на заказ?
Это услуга команды под ваш проект. Материалы и цифровые файлы подготовим после согласования задачи. Иллюстрации показывают формат, а не продаваемый готовый шаблон.
Когда нужно оплачивать?
Согласованный пример или диагностика — без предоплаты. После одобрения фиксируем состав, стоимость, оплату и оставшиеся этапы. Готовую работу и исходники передаём после согласованной оплаты.
Где будем общаться?
Предпочитаем Telegram. Можно выбрать WhatsApp, звонок или ВКонтакте. Заявка и переписка также сохранятся на личной странице на сайте.