Форматирование схемы XSD для экспертной оценки

Я разработал модель данных, которая представлена ​​схемой XSD. Модель данных также предоставляет типы, которые используются в качестве параметров веб-службы в дескрипторе WSDL.

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

Какой инструмент или метод презентации вы бы предложили использовать в качестве основы для экспертных оценок? Модель данных должна быть удобна для чтения для неквалифицированных людей, по крайней мере, когда речь идет о семантических значениях параметров.

Изменить:

Чтобы быть более конкретным: конечно, синтаксически схема проверяется. На самом деле я уже работаю над кодом, основанным на классах, сгенерированных JAXB. Моя цель

  1. чтобы заморозить модель данных и, следовательно, входные параметры
  2. чтобы убедиться, что ничего не потеряно и не забыто с семантической (в значении бизнес-значимой) точки зрения.

Изменить 2

Я думал о том, как, вероятно, было бы лучше распространить модель данных. Я думаю о чем-то вроде JavaDoc для схем XSD. Кто-нибудь знает, существует ли что-то подобное? В основном это можно сделать с помощью набора XSLT, верно?


xsd datamodel review
person poezn    schedule 14.10.2008    source источник
comment
см. также: stackoverflow .com / questions / 237938 /.   -  person f3lix    schedule 01.02.2011

Ответы (5)


arrow_upward
20
arrow_downward

Я знаю следующие инструменты, которые генерируют документацию из файлов схемы XML (XSD):

  • xs3p
    • XSLT stylesheet that generates single XHTML from XSD
  • xsddoc
    • free / LGPL
    • в основном на основе XSLT
    • JavaDoc как вывод
    • см. примеры xsddoc
  • xnsdoc
    • improved commercial version of xsddoc
    • бесплатно для личного / образовательного использования
    • JavaDoc как вывод
  • XSDdoc 2.0
    • commercial
    • JavaDoc как вывод

Для небольшой схемы XML я бы, вероятно, предложил использовать таблицу стилей xs3p XSLT. Для более сложной схемы я предлагаю использовать xsddoc.

person f3lix    schedule 10.02.2009

arrow_upward
0
arrow_downward

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

Фактические приложения - вот что делает схему интересной. Примеры не обязательно должны быть большими, сложными или полностью реалистичными. Их просто нужно скомпилировать. Другие люди захотят скопировать и вставить образцы кода.

Эти примеры представляют собой «привет, мир» схемы. И они действуют как своего рода модульный тест для схемы.

person S.Lott    schedule 14.10.2008

arrow_upward
0
arrow_downward

Самая близкая вещь к Javadoc для схемы XML, которую я видел, - это запуск инструмента Javadoc в источнике, сгенерированном из схемы. Для этого требуются две вещи: 1) ваша схема имеет внутренние элементы аннотации, документирующие ее, и 2) ваш исходный генератор использует эти аннотации как элементы Javadoc.

person Eddie    schedule 23.01.2009

arrow_upward
0
arrow_downward

Очень полезный разработчик Oxygen XML также поддерживает создание документации, см. http://www.oxygenxml.com/xml_schema_documentation.html (коммерческий, но есть полнофункциональная 30-дневная пробная версия)

Я попробую сейчас, нужен простой способ сгенерировать документ со всеми типами и доступным xsd: описание документации как простое описание интерфейса ...

person Gregor    schedule 29.03.2012

arrow_upward
0
arrow_downward

** Раскрытие информации: я работаю в Innovasys, разработчике инструмента документации, упомянутого ниже *

Вы можете ознакомиться с Документом Innovasys! Х. Помимо автоматического создания структурированной и связанной страницы для каждого элемента, простого типа, сложного типа, группы и группы атрибутов, он также будет генерировать связанные диаграммы XSD (включая последовательности / выбор и т. Д.) И таблицы структуры, которые включают аннотации из ваших XSD и понять отношения между элементами в ваших схемах. Вывод основан на шаблоне, поэтому вы можете адаптировать его к своему предпочтительному стилю и структуре. Он создаст вывод в готовый для Интернета HTML или скомпилированные файлы справки.

Уникально он также включает редактор WYSIWYG, который позволяет вам создавать дополнительный контент в дополнение к материалам, которые автоматически генерируются, и аннотациям из источника XSD - так что вы можете предоставить дополнительную контекстную информацию для вашего коллегиального обзора. Существует также функция расширений сообщества, которая позволяет людям, просматривающим сгенерированный результат, записывать комментарии и отзывы, которые можно просматривать и выполнять действия непосредственно из Document! ИКС.

person fubaar    schedule 11.08.2011