Документация API
Опиши для разработчиков аутентификацию, общие правила, коды ошибок, параметры и примеры каждого метода, чтобы интеграция шла без вопросов.
Промпт
Составь документацию публичного API системы бонусных баллов. Цель: чтобы разработчики партнёров интегрировались самостоятельно. Требования: дай адреса окружений, аутентификацию и общие правила (формат запросов, пагинация, идемпотентность, лимиты, формат времени), таблицу кодов ошибок и список методов; для каждого метода — путь, таблицы параметров запроса и полей ответа, примеры успешного и ошибочного ответа; для вебхуков — проверку подписи и повторы; добавь журнал изменений. Точно указывай типы и обязательность, ключи заменяй заглушками, пиши кратко.
- Источник
- Ofox
Как пользоваться
- 1
Нажмите «Сделать такое же»
Откроется Ofox Chat, структура документа уже подготовлена. Если вы не вошли, сначала войдите.
- 2
Сделайте своё
Измените выделенные части промпта, подставив свои детали.
- 3
Отправьте и создайте
Отправьте — Ofox Chat напишет документ целиком, его можно сразу скачать. Продолжайте диалог, чтобы доработать.
Частые вопросы
Какой файл я получу?
Готовый структурированный документ для скачивания (Word или PDF), а не просто текст в чате.
Нужно ли что-то подготовить?
Нет — можно отправить сразу, и Ofox Chat напишет первую версию по шаблону. Если приложить вводные, данные или готовые документы (вставить текстом или загрузить PDF, Word и другие файлы), результат будет точнее соответствовать вашей ситуации.
Можно ли изменить промпт?
Да. Промпт подставляется в поле ввода Ofox Chat — перед отправкой можно заменить тему на свою, добавить требования или убрать лишнее.
Можно ли просто скопировать промпт?
Да. Нажмите «Копировать» на карточке промпта, чтобы получить чистый текст, — он подойдёт и для других AI-инструментов для текстов.
Похожие
Ещё промпты: Разработка- Технический дизайнОпиши, как будет устроена система или функция: архитектура, модель данных, интерфейсы и альтернативы, производительность, риски и откат.Разработка
- Разбор инцидентаВосстанови ход инцидента по таймлайну, оцени ущерб, найди первопричину и назначь меры с ответственными и сроками.Разработка
- Выбор технологийЗадай критерии и веса исходя из задач бизнеса, сравни технологии с обоснованием оценок и дай рекомендацию с рисками и планом внедрения.Разработка
- План тестированияОпредели, что, как, где и до какого момента тестировать в релизе или проекте, чтобы у QA, разработки и продукта были общие ожидания.Разработка
- Регламент релизаРазложи выкатку на пошаговый регламент: проверки перед релизом, шаги, проверка после релиза и план отката с чёткими условиями.Разработка
- Стандарты кодаЕдиные правила написания кода для команды: обязательные и рекомендуемые, по именованию, структуре, обработке ошибок, безопасности и ревью — с примерами.Разработка
- Дизайн базы данныхОписание слоя данных: связи сущностей, таблицы и ограничения, запрос под каждый индекс, прогноз объёмов и архивация — основа для ревью схемы.Разработка
- План миграцииПлан переноса системы или данных: инвентаризация, выбор стратегии, синхронизация и сверка данных, поэтапное переключение и откат на каждом этапе.Разработка
- Итоги нагрузочного тестаОтчёт о тестировании производительности: пропускная способность, перцентили задержек и ресурсы по сценариям против целей, узкие места и вывод о готовности к запуску.Разработка
- Оценка безопасностиОтчёт об оценке безопасности системы: границы и модель угроз, находки с уровнем риска и доказательствами, рекомендации и план исправлений с повторной проверкой.Разработка
Есть своя идея? Начните создавать
Опишите нужное изображение одной фразой — Ofox Chat создаст его с нуля.