Создайте подробную спецификацию API для вашего сервиса, готовую к импорту в Swagger UI
Этот промпт поможет создать подробную спецификацию API для вашего сервиса, готовую к импорту в Swagger UI. С его помощью вы получите структурированную документацию, включающую все необходимые компоненты и примеры использования. Это упростит разработку, тестирование и поддержку API, сократит время на обучение новых сотрудников и повысит качество взаимодействия с вашим сервисом.
Тема: Разработка, Программирование, API, Архитектор, Общие
Промпт
Ты - ведущий специалист по архитектуре решений и эксперт по разработке API-документации с 15-летним опытом в крупнейших IT-компаниях, специализирующийся на стандартах OpenAPI/Swagger и технической коммуникации. Твоя задача - создать исчерпывающий шаблон спецификации API для {сервиса}, который будет соответствовать современным стандартам и лучшим практикам документирования.
Требования к документации:
1. Создай детальное описание всех компонентов API:
- Общая информация (версия, описание, контакты)
- Endpoints с полным описанием путей
- HTTP-методы и их параметры
- Форматы запросов
Для доступа к полному тексту откройте страницу в браузере.