OkDoc превращает OpenAPI/Swagger в красивый справочник с живой песочницей запросов. Свой домен, тёмная тема, поиск и обновление из CI/CD — всё включено.
Бесплатный тариф без карты. Поддомен acme.okdoc.cc — сразу.
Создаёт новый заказ и возвращает ссылку на оплату.
curl -X POST https://api.acme.com/v1/orders \
-H "Authorization: Bearer sk_live_…" \
-d '{"amount": 4900, "currency": "USD"}'{
"id": "ord_9f2k",
"status": "pending",
"checkout_url": "https://pay.acme.com/9f2k"
}Возможности
Как Mintlify или ReadMe — но проще, с русскоязычным интерфейсом и поддержкой, которая отвечает.
Файл, URL или JSON/YAML — справочник эндпоинтов с параметрами, схемами и примерами собирается автоматически. Swagger 2.0 конвертируется сам.
Кнопка «Попробовать» отправляет настоящий HTTP-запрос к вашему API через защищённый прокси — без CORS. Ответ, заголовки и время — на той же странице.
docs.yourcompany.com вместо поддомена. Подтверждение через DNS, сертификат выпускается автоматически.
Следование системной теме, фирменный цвет и логотип — документация выглядит как часть вашего продукта.
Мгновенный поиск по страницам и эндпоинтам (⌘K), оглавление, группы и разделы — читатель находит нужное за секунды.
Рабочие пространства, роли участников, API-ключи для обновления документации прямо из CI/CD.
Как это работает
Название, поддомен, логотип и фирменный цвет. Через минуту документация уже доступна по адресу вида acme.okdoc.cc.
Файл, URL или текст. Swagger 2.0 и OpenAPI 3.x. Страницы-руководства — в Markdown с подсветкой кода и коллаутами.
Добавьте CNAME и TXT-записи, нажмите «Проверить» — SSL выпустится автоматически. Обновляйте спецификацию из CI/CD.
# .github/workflows/docs.yml
- name: Publish API docs
run: |
curl -X PUT https://okdoc.cc/api/v1/projects/$PROJECT/specs/$SPEC \
-H "Authorization: Bearer $OKDOC_API_KEY" \
-H "Content-Type: application/yaml" \
--data-binary @openapi.yamlТарифы
Начните бесплатно и переходите на платный тариф, когда понадобятся свои домены и команда.
1 проект · 1 участник
До 5 проектов · до 5 участников
До 50 проектов · до 50 участников
Цены в долларах США. Нужен корпоративный тариф или оплата по счёту? Напишите нам.
OpenAPI 3.0 и 3.1 в JSON или YAML, а также Swagger 2.0 — он автоматически конвертируется в OpenAPI 3. Ссылки $ref разрешаются при импорте.
Запрос уходит на ваш API через прокси OkDoc, поэтому CORS настраивать не нужно. Прокси не пропускает запросы во внутренние сети и не хранит ответы.
Да. Создайте API-ключ в настройках рабочего пространства и вызывайте PUT /api/v1/projects/:id/specs/:specId из CI/CD — документация обновится за секунды.
Опубликованная документация продолжит работать. Мы лишь попросим перейти на следующий тариф, чтобы добавить новые проекты, домены или участников.
Бесплатный тариф, без карты. Импортируйте OpenAPI — и делитесь ссылкой с разработчиками через 10 минут.
Начать бесплатно