Приведу существующий REST API в состояние, когда его можно уверенно передать разработчику, интегратору или команде тестирования.
Для API до 10 эндпоинтов подготовлю:
- спецификацию OpenAPI 3 в YAML или JSON;
- интерактивную Swagger-документацию;
- Postman-коллекцию с переменными окружения;
- позитивные и негативные примеры запросов;
- базовые автотесты на Python и pytest;
- README с запуском и проверкой;
- список найденных несоответствий и рисков;
- один круг правок по согласованному объему.
Проверю HTTP-статусы, обязательные поля, авторизацию, валидацию и типовые ошибки. Работаю с исходным кодом, существующей схемой или локально запускаемым тестовым API. Доступ к production не требуется. Все согласования проходят письменно, созвон не нужен.
Не входят разработка самого API, исправление всех найденных дефектов, нагрузочное тестирование, несколько независимых сервисов и работа с реальными production-секретами. Для старта нужны исходники или текущая схема, инструкция запуска, тестовые переменные, примеры данных, правила авторизации и ожидаемые ответы.