Как вы документируете преобразование дерева в дерево в удобочитаемом формате?

Question

Мне нужно документировать приложение, которое служит фасадом для набора веб-сервисов. Приложение принимает запросы SOAP и преобразует эти запросы в формат, понятный базовому веб-сервису. Есть несколько таких сервисов, каждый со своим интерфейсом. Некоторые принимают SOAP, некоторые HTTP POST, некоторые ... другие форматы, не упомянутые в вежливом обществе.

Мне нужно документировать, как мы отображаем поля из наших SOAP-вызовов в поля для этих других форматов. Прежде чем все кричат ​​«XSLT», я должен упомянуть, что обозначение должно быть удобным для человека. В идеале это было бы что-то в Excel.

С кем-либо сталкивались такие проблемы раньше? Как вы его решили? Есть ли дружественная для человека нотация преобразований дерева-дерева, которая может поместиться в электронную таблицу?

Answer 1

Мне нужно было сделать это. То, как я это делал, это просто начать писать, следуя иерархической структуре.

В конечном итоге я обнаружил, что повторяюсь. Например, некоторые элементы имели общий набор атрибутов. Я бы вытащил документацию об этой общей настройке перед разделами по конкретным элементам. То же самое с документацией по обработке конкретных простых типов.

В конце концов, было даже некоторое обсуждение на высоком уровне об общем потоке и «философии» трансформации. Но я позволял все это происходить пополам, исправляя его, когда мне стало скучно повторять.

Тем не менее, я разработчик, а не технический писатель.

Answer 2

Я до сих пор ничего не нашел, но нашел множество указателей на многие библиотеки, которые помогают преобразовывать объекты одного типа в другой в Java. Для справки, я перечисляю наиболее перспективные из них здесь, все делать какие-то JavaBean для преобразования JavaBean:

• Transmorph
• EZMorph
• Dozer