ReadMe — платформа для документации API: справочник с интерактивными запросами, руководства, журнал изменений и аналитика использования API в одном месте.
Главное отличие от GitBook и Docusaurus: ReadMe строит документацию из спецификации OpenAPI и показывает, как клиенты реально вызывают ваш API, включая логи запросов.
Возможности
- Интерактивный справочник API из OpenAPI: запрос можно отправить прямо со страницы.
- Двусторонняя синхронизация с GitHub и редактор Markdown.
- Аналитика: просмотры документации и логи запросов к API.
- AI-функции: llms.txt, MCP-сервер документации, AI-помощник для авторов.
- Свой домен и темы оформления даже на бесплатном тарифе.
Кому подходит
Компаниям с публичным API, которым нужна понятная документация для внешних разработчиков и партнёров.
Как начать
Зарегистрируйтесь, создайте проект и загрузите файл OpenAPI или подключите репозиторий GitHub. Справочник API соберётся автоматически, руководства добавьте вручную.
Совет
Включите llms.txt и MCP-сервер: так AI-ассистенты вроде Claude и Cursor будут точнее отвечать на вопросы о вашем API.
Ограничения
На бесплатном тарифе один администратор, одна версия и метрики только за 7 дней. Pro стоит $250 в месяц — дорого для небольшого проекта. Бесплатные альтернативы — Docusaurus и Mintlify на стартовых тарифах.