Мне нужно задокументировать приложение, которое служит фасадом для набора веб-сервисов. Приложение принимает запросы SOAP и преобразует эти запросы в формат, понятный базовой веб-службе. Таких сервисов несколько, каждый со своим интерфейсом. Некоторые принимают SOAP, некоторые HTTP POST, некоторые... другие форматы, не упомянутые в приличном обществе.
Мне нужно задокументировать, как мы сопоставляем поля из наших вызовов SOAP с полями для этих других форматов. Прежде чем все закричат «XSLT», я должен упомянуть, что нотация должна быть удобной для человека. В идеале это должно быть что-то в Excel.
Кто-нибудь сталкивался с такими проблемами раньше? Как вы это решили? Существует ли удобная для человека нотация для преобразования дерева в дерево, которая может поместиться в электронной таблице?
2 ответа
Я должен был сделать только это. Я просто начал писать, следуя иерархической структуре.
В конце концов я обнаружил, что повторяюсь. Например, некоторые элементы имели общий набор атрибутов. Я бы вытащил документацию по этой общей настройке перед разделами, посвященными конкретным элементам. То же самое с документацией по обработке определенных простых типов.
В конце концов, на высоком уровне даже состоялось обсуждение общего потока и «философии» трансформации. Но я позволяла всему этому происходить по крупицам, исправляла по мере того, как мне становилось скучно повторяться.
Тем не менее, я разработчик, а не технический писатель.
Я пока толком ничего не нашел, но нашел указатели на множество библиотек, помогающих преобразовывать объекты одного типа в другой в Java. Для справки, я перечисляю наиболее многообещающие из них, все они выполняют какое-то преобразование JavaBean в JavaBean:
Похожие вопросы
Новые вопросы
web-services
«Веб-сервис» - это программная система, предназначенная для поддержки взаимодействия компьютеров между компьютерами через Всемирную паутину.