VIP 👤
🏠 الرئيسية
المقاييس
📊 جميع المقاييس 🦖 ديناصور v1 🦖 ديناصور v2 ✅ تطبيقات قائمة المهام 🎨 صفحات حرة إبداعية 🎯 FSACB - العرض النهائي 🌍 مقياس الترجمة
النماذج
🏆 أفضل 10 نماذج 🆓 نماذج مجانية 📋 جميع النماذج ⚙️ كيلو كود
الموارد
💬 مكتبة الأوامر 📖 قاموس الذكاء الاصطناعي 🔗 روابط مفيدة 🔌 واجهات API والموجّهات
advanced

Создание технической спецификации API

#документация #API #REST #техническое письмо

Создайте исчерпывающую документацию для REST API на основе описания бизнес-логики, включая примеры запросов и обработки ошибок.

Действуй как технический писатель, специализирующийся на спецификациях API. Создай полную документацию (OpenAPI/Swagger формат) для REST API системы '[Описание системы]'. Документация должна включать: эндпоинты, методы HTTP, параметры пути и строки запроса, тела запросов и ответов (JSON-схемы), коды статусов ответов, описание возможных ошибок и примеры использования curl. Удели особое внимание безопасности (аутентификация/авторизация).