← All posts tagged apiary

Пощупал побольше apiary.io и решили попробовать перенести часть документаций API туда. Из того что я пропустил в первый раз. Оказалось что в первую очередь они позиционируют себя не как способ написания документаций к API и его тестирования, а к прототипированию API. Т.е надо сначала описать API, ресурсы, параметры запросов и что ожидается в ответ, а потом apiary.io на основе этой спеки запускает свой сервер который будет отвечать на ваши http запросы по описанным вами адресам, при этом отвечать теми заготовками которые тоже описаны в спеке. Таким образом мы можем описывать прототип и тут же например разработчик для телефонов может разрабатывать приложения которое будет делать запросы на ваш mock server. Это тоже интересно для меня, но я его рассматривал как способ написания документаций API и его тестирования. Но есть интересный момент, можно в настройках сказать что бы apiary.io проксировал запросы на реальный сервер, и таким образом когда мы напишем реализацию нашего сервера, сможем прозрачно переключится на реальный. Но самое вкусное пока у ребят только запланировано:
1. что бы они сами периодически опрашивали API и сравнивали ответы с документацией (они уже сейчас умеют сравнивать ответы), и в случае провала теста оповещала о том что что то не так
2. пока не решена проблема авторизаций, т.е все запросы изолированы, и нельзя полноценно делать тесты (для себя пока временно решил проблему через описания заголовка HTTP Base Authentication в документаций)
Идея очень интересная, но пока сервис сырой и не хватает фишечек. Например я не знаю как они будут решать проблему изолированных запросов, иначе все превратится просто в написание на markdown тест кейсов с набором данных, потому что как иначе тестировать POST/DELETE/PUT запросы я не знаю, в итоге может выльется что проще писать всё по старинке. Может они и правы что сделали акцент на прототипирование.