Промпты для технологий и разработки
Создавайте документацию API уровня Stripe - аутентификация, конечные точки, ошибки, вебхуки - чтобы разработчики могли пройти аутентификацию, выполнить первый вызов и обработать ошибку менее чем за 10 минут.
Этот prompt для генерации документации AI API создаёт документацию, согласованную со спецификацией OpenAPI: обзор, руководство по аутентификации, быстрый старт, справочник конечных точек с примерами кода на разных языках, обработка ошибок с решениями, ограничение частоты запросов, вебхуки, SDK, политика версионирования и журнал изменений - в формате, который используют лидеры developer experience. Вставьте его в Claude, ChatGPT или любой AI-чат, добавьте спецификацию API и получите документацию, готовую для Docusaurus, ReadMe, Mintlify или GitBook.
Аутентификация стоит на первом месте - разработчик, который не может пройти аутентификацию, сдаётся. Каждый ответ с ошибкой документируется с указанием кода статуса, причины и способа исправления (молчаливые ошибки запрещены). Для каждой конечной точки приводятся полные реалистичные примеры запросов и ответов на нескольких языках - значения-заполнители «example_value_1» недопустимы. Работает с Claude, ChatGPT и любой другой моделью AI-чата.
Что вы получаете
- Один готовый к использованию в продакшене prompt для генерации документации AI API (900+ слов)
- Полная структура документации - обзор, аутентификация, быстрый старт, справочник конечных точек, ошибки, ограничения частоты запросов, вебхуки, SDK, журнал изменений
- Справочник конечных точек с примерами кода на разных языках (cURL, Python, JavaScript, Go, Ruby - выберите 3-5)
- Полная таблица кодов ошибок - статус, код, причина и способ устранения для каждой ошибки
- Настройка для REST, GraphQL, API с большим количеством вебхуков, корпоративных/SOAP, внутренних и партнёрских API
Создано для
Бэкенд-разработчики
Команды платформы
Отдел по работе с разработчиками
Технические архитекторы
Инженеры DX