ActionSpec — описание Rails API и генерация документа OpenAPI

ActionSpec — решение для документирования API в приложениях на Ruby on Rails. Оно помогает разработчикам автоматически генерировать документацию в формате OpenAPI и валидировать входящие параметры.
Возможности и состав проекта
Проект позволяет определять параметры запросов (заголовки, путь, тело, куки) с указанием типов, значений по умолчанию, правил трансформации и валидации. С помощью DSL-синтаксиса можно описывать схемы данных для запросов и ответов, включая вложенные объекты и массивы, а также объявлять обязательные поля.
Начало работы и требования
ActionSpec требует Ruby 3.1+ и Rails 7.0+. Проект был реализован с помощью AI-агента и пока не прошёл ручную проверку или валидацию в производственных условиях. В комплекте поставляются детальные тесты RSpec, также сгенерированные AI-агентом.
Ограничения и выбор сценария
Автор прямо сообщает об отсутствии ручного ревью и production-валидации. Подробные сгенерированные тесты не заменяют проверку семантики DSL, параметров и ответов на реальном Rails-приложении. Генератор включает только описанные действия с подходящими routes, поэтому документация может не охватить весь API. Указанная версия OpenAPI 3.2.0 должна поддерживаться потребителями схемы. Сначала проверьте несколько endpoint и сравните поведение валидации с ожидаемыми контрактами.
Лицензия и условия использования
GitHub определяет лицензию репозитория как MIT. Перед использованием и распространением проверьте полный текст LICENSE и отдельные условия зависимостей, данных или моделей: лицензия репозитория не заменяет их лицензии.





