Инструменты и примеры

Скачиваемые материалы

• Postman коллекция: /examples/postman/ShopStory Public API.postman_collection.json
• CSS бейдж трансляции: /examples/stream-badge.css
• OpenAPI спецификация: /downloads/public-openapi.yaml
• Redoc просмотр: /swagger/

Рекомендуемая среда

1. Импортируйте Postman коллекцию и создайте окружение с переменными baseUrl, applicationId, deepLinkHost.
2. Для командной работы используйте Insomnia или Hoppscotch.
3. Контрактные тесты: Prism, Dredd или Schemathesis.
4. Линтинг OpenAPI: openapi-cli или spectral.

Поиск по документации

Мы рекомендуем подключить Algolia DocSearch. Запросите индекс и заполните переменные окружения:

ALGOLIA_APP_ID=XXXX
ALGOLIA_API_KEY=XXXX
ALGOLIA_INDEX_NAME=shopstory_public_api

В CI эти переменные передаются как protected variables, а у фронтенда используется apiKey с правами поиска.

Отчётность и мониторинг

• Включите ежедневный прогон smoke-тестов через cron job.
• Стройте метрики по времени ответа и коду status конверта.
• Отслеживайте ведущие изменения в Changelog.

Обратная связь

Наши разработчики отвечают в support@shopstory.live. Делитесь примерами кода и кейсами — мы обновим документацию.