Сам документирование интерфейса REST
У меня есть основанный на направляющих сервер, выполняющий несколько сервисов REST и основанный на направляющих веб-UI, который взаимодействует с использованием сервера ActiveResource. Тот же сервер используется другими клиентами (например: мобильный). Я должен генерировать документацию для остальных, взаимодействуют через интерфейс. Я должен предоставить услугу URL, ввод/вывод и ошибочная структура документа для каждого сервиса.
Идеально, я хотел бы использовать перехватчик в стороне сервера, которая зарегистрирует сервис на основе существующего трафика. Я задаюсь вопросом, существует ли драгоценный камень, чтобы сделать это.
1 ответ
Когда вы применяете архитектурный стиль REST, вам не нужно документировать свой интерфейс.
Контракт между клиентом и сервером устанавливается используемым типом носителя. Если вам нужна какая-либо другая дополнительная документация, вы не используете RESTful.
Итак, вместо того, чтобы беспокоиться о документировании своей услуги, приложите все усилия по описанию к документированию ваших типов мультимедиа. Знания о типах носителей - это все, что необходимо для реализации клиентов для вашего сервера.