4.10. Улучшение документации REST API

В течение долгого времени документацией для REST API Synergy выступал сгенерированный на основе исходного кода Javadoc, который удобен для документирования кода на Java, но не очень приспособлен для REST API.

В этой версии мы добавили новый вид документации на REST API, которая доступна как на tdd.lan.arta.kz, так и в комплекте с вашей установленной Synergy, например:

http://demoextfp.synergy.tm/Synergy/api

Новая документация имеет более понятную структуру, цветовую индикацию метода (POST, GET, PUT, DELETE), а также возможность ввода параметров и выполнения запроса прямо на странице документации!

Рисунок 4.3. Новый вид документации

Новый вид документации

Новая документация покрывает большую часть методов API, но пока имеется некоторая небольшая часть методов, которая не попала в неё. Мы будем и далее работать над улучшением нашей документации, а пока в случае возникновения спорных вопросов рекомендуем обращаться к javadoc.